diff --git a/SwagGuidedShopping-adminapi.json b/SwagGuidedShopping-adminapi.json index e652dac..815e9d8 100644 --- a/SwagGuidedShopping-adminapi.json +++ b/SwagGuidedShopping-adminapi.json @@ -3,7 +3,11 @@ "info": { "title": "Shopware Admin API", "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.\n\nFor a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints\nadd the query parameter `type=jsonapi`.", - "version": "6.6.1.0" + "license": { + "name": "MIT", + "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" + }, + "version": "6.6.10.5" }, "servers": [ { @@ -11,43 +15,38 @@ } ], "paths": { - "/guided-shopping-appointment": { - "get": { + "/aggregate/acl-role": { + "post": { "tags": [ - "Guided Shopping Appointment" + "Acl Role" ], - "summary": "List with basic information of Guided Shopping Appointment resources.", - "description": "", - "operationId": "getGuidedShoppingAppointmentList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "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 Guided Shopping Appointment resources.", + "description": "List of AclRole", "content": { "application/vnd.api+json": { "schema": { @@ -59,41 +58,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/guided-shopping-appointment?limit=25" - }, - "last": { - "example": "/guided-shopping-appointment?limit=25&page=11" - }, - "next": { - "example": "/guided-shopping-appointment?limit=25&page=4" - }, - "prev": { - "example": "/guided-shopping-appointment?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } } } } @@ -110,7 +78,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" + "$ref": "#/components/schemas/AclRole" } } } @@ -118,62 +86,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/app": { "post": { "tags": [ - "Appointment" - ], - "summary": "Create a new appointment", - "description": "", - "operationId": "createAppointment", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "App" ], + "summary": "Aggregate for the App resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateApp", "requestBody": { + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Appointment" + }, + "required": [ + "aggregations" + ] } } - }, - "required": false + } }, "responses": { "200": { - "description": "Detail of GuidedShoppingAppointment", + "description": "List of App", "content": { "application/vnd.api+json": { "schema": { @@ -185,7 +138,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" + "type": "array", + "items": { + "$ref": "#/components/schemas/App" + } } } } @@ -195,12 +151,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" + "type": "array", + "items": { + "$ref": "#/components/schemas/App" + } } } } @@ -212,39 +171,42 @@ }, "401": { "$ref": "#/components/responses/401" - }, - "204": { - "description": "" } } } }, - "/search/guided-shopping-appointment": { + "/aggregate/app-action-button": { "post": { "tags": [ - "Appointment" + "App Action Button" ], - "summary": "Search appointments", - "description": "Return list of appointments", - "operationId": "searchAppointments", + "summary": "Aggregate for the App Action Button resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppActionButton", "requestBody": { - "required": false, + "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GetListBodyRequest" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "", + "description": "List of AppActionButton", "content": { "application/vnd.api+json": { "schema": { @@ -258,7 +220,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" + "$ref": "#/components/schemas/AppActionButton" } } } @@ -276,13 +238,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Appointment" - } - }, - "aggregations": { - "type": "array", - "items": { - "type": "object" + "$ref": "#/components/schemas/AppActionButton" } } } @@ -296,33 +252,41 @@ "401": { "$ref": "#/components/responses/401" } - }, - "parameters": [] + } } }, - "/guided-shopping-appointment/{id}": { - "get": { + "/aggregate/app-administration-snippet": { + "post": { "tags": [ - "Guided Shopping Appointment" + "App Administration Snippet" ], - "summary": "Detailed information about a Guided Shopping Appointment resource.", - "description": "", - "operationId": "getGuidedShoppingAppointment", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "Detail of GuidedShoppingAppointment", + "description": "List of AppAdministrationSnippet", "content": { "application/vnd.api+json": { "schema": { @@ -334,7 +298,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } } } } @@ -344,124 +311,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Guided Shopping Appointment" - ], - "summary": "Delete a Guided Shopping Appointment resource.", - "description": "", - "operationId": "deleteGuidedShoppingAppointment", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/app-cms-block": { + "post": { "tags": [ - "Guided Shopping Appointment" - ], - "summary": "Partially update information about a Guided Shopping Appointment resource.", - "description": "", - "operationId": "updateGuidedShoppingAppointment", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "App Cms Block" ], + "summary": "Aggregate for the App Cms Block resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppCmsBlock", "requestBody": { - "description": "Partially update information about a Guided Shopping Appointment resource.", + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of GuidedShoppingAppointment", + "description": "List of AppCmsBlock", "content": { "application/vnd.api+json": { "schema": { @@ -473,7 +378,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } } } } @@ -483,12 +391,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } } } } @@ -498,52 +409,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/guided-shopping-appointment-attendee": { - "get": { + "/aggregate/app-flow-action": { + "post": { "tags": [ - "Guided Shopping Appointment Attendee" + "App Flow Action" ], - "summary": "List with basic information of Guided Shopping Appointment Attendee resources.", - "description": "", - "operationId": "getGuidedShoppingAppointmentAttendeeList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "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 Guided Shopping Appointment Attendee resources.", + "description": "List of AppFlowAction", "content": { "application/vnd.api+json": { "schema": { @@ -555,41 +458,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/guided-shopping-appointment-attendee?limit=25" - }, - "last": { - "example": "/guided-shopping-appointment-attendee?limit=25&page=11" - }, - "next": { - "example": "/guided-shopping-appointment-attendee?limit=25&page=4" - }, - "prev": { - "example": "/guided-shopping-appointment-attendee?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } } } } @@ -606,7 +478,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + "$ref": "#/components/schemas/AppFlowAction" } } } @@ -614,61 +486,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/app-flow-event": { "post": { "tags": [ - "Guided Shopping Appointment Attendee" - ], - "summary": "Create a new Guided Shopping Appointment Attendee resources.", - "description": "", - "operationId": "createGuidedShoppingAppointmentAttendee", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "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/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of GuidedShoppingAppointmentAttendee", + "description": "List of AppFlowEvent", "content": { "application/vnd.api+json": { "schema": { @@ -680,7 +538,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } } } } @@ -690,12 +551,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } } } } @@ -711,32 +575,38 @@ } } }, - "/search/guided-shopping-appointment-attendee": { + "/aggregate/app-payment-method": { "post": { "tags": [ - "Guided Shopping Appointment Attendee" + "App Payment Method" ], - "summary": "Search for the Guided Shopping Appointment Attendee resources.", - "description": "", - "operationId": "searchGuidedShoppingAppointmentAttendee", + "summary": "Aggregate for the App Payment Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppPaymentMethod", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of GuidedShoppingAppointmentAttendee", + "description": "List of AppPaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -750,7 +620,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + "$ref": "#/components/schemas/AppPaymentMethod" } } } @@ -768,7 +638,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + "$ref": "#/components/schemas/AppPaymentMethod" } } } @@ -785,29 +655,38 @@ } } }, - "/guided-shopping-appointment-attendee/{id}": { - "get": { + "/aggregate/app-script-condition": { + "post": { "tags": [ - "Guided Shopping Appointment Attendee" + "App Script Condition" ], - "summary": "Detailed information about a Guided Shopping Appointment Attendee resource.", - "description": "", - "operationId": "getGuidedShoppingAppointmentAttendee", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment_attendee", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "Detail of GuidedShoppingAppointmentAttendee", + "description": "List of AppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -819,7 +698,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } } } } @@ -829,124 +711,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Guided Shopping Appointment Attendee" - ], - "summary": "Delete a Guided Shopping Appointment Attendee resource.", - "description": "", - "operationId": "deleteGuidedShoppingAppointmentAttendee", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment_attendee", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/app-shipping-method": { + "post": { "tags": [ - "Guided Shopping Appointment Attendee" - ], - "summary": "Partially update information about a Guided Shopping Appointment Attendee resource.", - "description": "", - "operationId": "updateGuidedShoppingAppointmentAttendee", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment_attendee", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "App Shipping Method" ], + "summary": "Aggregate for the App Shipping Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppShippingMethod", "requestBody": { - "description": "Partially update information about a Guided Shopping Appointment Attendee resource.", + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of GuidedShoppingAppointmentAttendee", + "description": "List of AppShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -958,7 +778,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } } } } @@ -968,12 +791,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } } } } @@ -983,52 +809,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/guided-shopping-appointment-video-chat": { - "get": { + "/aggregate/app-template": { + "post": { "tags": [ - "Guided Shopping Appointment Video Chat" + "App Template" ], - "summary": "List with basic information of Guided Shopping Appointment Video Chat resources.", - "description": "", - "operationId": "getGuidedShoppingAppointmentVideoChatList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "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 Guided Shopping Appointment Video Chat resources.", + "description": "List of AppTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -1040,41 +858,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/guided-shopping-appointment-video-chat?limit=25" - }, - "last": { - "example": "/guided-shopping-appointment-video-chat?limit=25&page=11" - }, - "next": { - "example": "/guided-shopping-appointment-video-chat?limit=25&page=4" - }, - "prev": { - "example": "/guided-shopping-appointment-video-chat?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } } } } @@ -1091,7 +878,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + "$ref": "#/components/schemas/AppTemplate" } } } @@ -1099,61 +886,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/category": { "post": { "tags": [ - "Guided Shopping Appointment Video Chat" - ], - "summary": "Create a new Guided Shopping Appointment Video Chat resources.", - "description": "", - "operationId": "createGuidedShoppingAppointmentVideoChat", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Category" ], + "summary": "Aggregate for the Category resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCategory", "requestBody": { + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of GuidedShoppingAppointmentVideoChat", + "description": "List of Category", "content": { "application/vnd.api+json": { "schema": { @@ -1165,7 +938,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } } } } @@ -1175,12 +951,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } } } } @@ -1196,32 +975,38 @@ } } }, - "/search/guided-shopping-appointment-video-chat": { + "/aggregate/cms-block": { "post": { "tags": [ - "Guided Shopping Appointment Video Chat" + "Cms Block" ], - "summary": "Search for the Guided Shopping Appointment Video Chat resources.", - "description": "", - "operationId": "searchGuidedShoppingAppointmentVideoChat", + "summary": "Aggregate for the Cms Block resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsBlock", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of GuidedShoppingAppointmentVideoChat", + "description": "List of CmsBlock", "content": { "application/vnd.api+json": { "schema": { @@ -1235,7 +1020,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -1253,7 +1038,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -1270,29 +1055,38 @@ } } }, - "/guided-shopping-appointment-video-chat/{id}": { - "get": { + "/aggregate/cms-page": { + "post": { "tags": [ - "Guided Shopping Appointment Video Chat" + "Cms Page" ], - "summary": "Detailed information about a Guided Shopping Appointment Video Chat resource.", - "description": "", - "operationId": "getGuidedShoppingAppointmentVideoChat", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment_video_chat", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "Detail of GuidedShoppingAppointmentVideoChat", + "description": "List of CmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -1304,7 +1098,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } } } } @@ -1314,124 +1111,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Guided Shopping Appointment Video Chat" - ], - "summary": "Delete a Guided Shopping Appointment Video Chat resource.", - "description": "", - "operationId": "deleteGuidedShoppingAppointmentVideoChat", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment_video_chat", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/cms-section": { + "post": { "tags": [ - "Guided Shopping Appointment Video Chat" - ], - "summary": "Partially update information about a Guided Shopping Appointment Video Chat resource.", - "description": "", - "operationId": "updateGuidedShoppingAppointmentVideoChat", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment_video_chat", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Cms Section" ], + "summary": "Aggregate for the Cms Section resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsSection", "requestBody": { - "description": "Partially update information about a Guided Shopping Appointment Video Chat resource.", + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of GuidedShoppingAppointmentVideoChat", + "description": "List of CmsSection", "content": { "application/vnd.api+json": { "schema": { @@ -1443,7 +1178,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } } } } @@ -1453,12 +1191,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } } } } @@ -1468,52 +1209,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/guided-shopping-attendee-product-collection": { - "get": { + "/aggregate/cms-slot": { + "post": { "tags": [ - "Guided Shopping Attendee Product Collection" + "Cms Slot" ], - "summary": "List with basic information of Guided Shopping Attendee Product Collection resources.", - "description": "", - "operationId": "getGuidedShoppingAttendeeProductCollectionList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "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 Guided Shopping Attendee Product Collection resources.", + "description": "List of CmsSlot", "content": { "application/vnd.api+json": { "schema": { @@ -1525,41 +1258,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/guided-shopping-attendee-product-collection?limit=25" - }, - "last": { - "example": "/guided-shopping-attendee-product-collection?limit=25&page=11" - }, - "next": { - "example": "/guided-shopping-attendee-product-collection?limit=25&page=4" - }, - "prev": { - "example": "/guided-shopping-attendee-product-collection?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } } } } @@ -1576,7 +1278,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + "$ref": "#/components/schemas/CmsSlot" } } } @@ -1584,61 +1286,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/country": { "post": { "tags": [ - "Guided Shopping Attendee Product Collection" - ], - "summary": "Create a new Guided Shopping Attendee Product Collection resources.", - "description": "", - "operationId": "createGuidedShoppingAttendeeProductCollection", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Country" ], + "summary": "Aggregate for the Country resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCountry", "requestBody": { + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of GuidedShoppingAttendeeProductCollection", + "description": "List of Country", "content": { "application/vnd.api+json": { "schema": { @@ -1650,7 +1338,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } } } } @@ -1660,12 +1351,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } } } } @@ -1681,32 +1375,38 @@ } } }, - "/search/guided-shopping-attendee-product-collection": { + "/aggregate/country-state": { "post": { "tags": [ - "Guided Shopping Attendee Product Collection" + "Country State" ], - "summary": "Search for the Guided Shopping Attendee Product Collection resources.", - "description": "", - "operationId": "searchGuidedShoppingAttendeeProductCollection", + "summary": "Aggregate for the Country State resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCountryState", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of GuidedShoppingAttendeeProductCollection", + "description": "List of CountryState", "content": { "application/vnd.api+json": { "schema": { @@ -1720,7 +1420,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + "$ref": "#/components/schemas/CountryState" } } } @@ -1738,7 +1438,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + "$ref": "#/components/schemas/CountryState" } } } @@ -1755,29 +1455,38 @@ } } }, - "/guided-shopping-attendee-product-collection/{id}": { - "get": { + "/aggregate/currency": { + "post": { "tags": [ - "Guided Shopping Attendee Product Collection" + "Currency" ], - "summary": "Detailed information about a Guided Shopping Attendee Product Collection resource.", - "description": "", - "operationId": "getGuidedShoppingAttendeeProductCollection", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_attendee_product_collection", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "Detail of GuidedShoppingAttendeeProductCollection", + "description": "List of Currency", "content": { "application/vnd.api+json": { "schema": { @@ -1789,7 +1498,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } } } } @@ -1799,124 +1511,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Guided Shopping Attendee Product Collection" - ], - "summary": "Delete a Guided Shopping Attendee Product Collection resource.", - "description": "", - "operationId": "deleteGuidedShoppingAttendeeProductCollection", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_attendee_product_collection", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/currency-country-rounding": { + "post": { "tags": [ - "Guided Shopping Attendee Product Collection" - ], - "summary": "Partially update information about a Guided Shopping Attendee Product Collection resource.", - "description": "", - "operationId": "updateGuidedShoppingAttendeeProductCollection", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_attendee_product_collection", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Currency Country Rounding" ], + "summary": "Aggregate for the Currency Country Rounding resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCurrencyCountryRounding", "requestBody": { - "description": "Partially update information about a Guided Shopping Attendee Product Collection resource.", + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of GuidedShoppingAttendeeProductCollection", + "description": "List of CurrencyCountryRounding", "content": { "application/vnd.api+json": { "schema": { @@ -1928,7 +1578,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } } } } @@ -1938,12 +1591,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } } } } @@ -1953,52 +1609,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/guided-shopping-interaction": { - "get": { + "/aggregate/custom-entity": { + "post": { "tags": [ - "Guided Shopping Interaction" + "Custom Entity" ], - "summary": "List with basic information of Guided Shopping Interaction resources.", - "description": "", - "operationId": "getGuidedShoppingInteractionList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "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 Guided Shopping Interaction resources.", + "description": "List of CustomEntity", "content": { "application/vnd.api+json": { "schema": { @@ -2010,41 +1658,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/guided-shopping-interaction?limit=25" - }, - "last": { - "example": "/guided-shopping-interaction?limit=25&page=11" - }, - "next": { - "example": "/guided-shopping-interaction?limit=25&page=4" - }, - "prev": { - "example": "/guided-shopping-interaction?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomEntity" + } } } } @@ -2061,7 +1678,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" + "$ref": "#/components/schemas/CustomEntity" } } } @@ -2069,61 +1686,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/custom-field": { "post": { "tags": [ - "Guided Shopping Interaction" - ], - "summary": "Create a new Guided Shopping Interaction resources.", - "description": "", - "operationId": "createGuidedShoppingInteraction", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Custom Field" ], + "summary": "Aggregate for the Custom Field resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomField", "requestBody": { + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of GuidedShoppingInteraction", + "description": "List of CustomField", "content": { "application/vnd.api+json": { "schema": { @@ -2135,7 +1738,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } } } } @@ -2145,12 +1751,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } } } } @@ -2166,32 +1775,38 @@ } } }, - "/search/guided-shopping-interaction": { + "/aggregate/custom-field-set": { "post": { "tags": [ - "Guided Shopping Interaction" + "Custom Field Set" ], - "summary": "Search for the Guided Shopping Interaction resources.", - "description": "", - "operationId": "searchGuidedShoppingInteraction", + "summary": "Aggregate for the Custom Field Set resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomFieldSet", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of GuidedShoppingInteraction", + "description": "List of CustomFieldSet", "content": { "application/vnd.api+json": { "schema": { @@ -2205,7 +1820,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -2223,7 +1838,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -2240,29 +1855,38 @@ } } }, - "/guided-shopping-interaction/{id}": { - "get": { + "/aggregate/custom-field-set-relation": { + "post": { "tags": [ - "Guided Shopping Interaction" + "Custom Field Set Relation" ], - "summary": "Detailed information about a Guided Shopping Interaction resource.", - "description": "", - "operationId": "getGuidedShoppingInteraction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_interaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "Detail of GuidedShoppingInteraction", + "description": "List of CustomFieldSetRelation", "content": { "application/vnd.api+json": { "schema": { @@ -2274,7 +1898,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } } } } @@ -2284,124 +1911,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Guided Shopping Interaction" - ], - "summary": "Delete a Guided Shopping Interaction resource.", - "description": "", - "operationId": "deleteGuidedShoppingInteraction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_interaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/customer": { + "post": { "tags": [ - "Guided Shopping Interaction" - ], - "summary": "Partially update information about a Guided Shopping Interaction resource.", - "description": "", - "operationId": "updateGuidedShoppingInteraction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_interaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Customer" ], + "summary": "Aggregate for the Customer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomer", "requestBody": { - "description": "Partially update information about a Guided Shopping Interaction resource.", + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of GuidedShoppingInteraction", + "description": "List of Customer", "content": { "application/vnd.api+json": { "schema": { @@ -2413,7 +1978,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } } } } @@ -2423,12 +1991,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } } } } @@ -2438,52 +2009,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/guided-shopping-presentation": { - "get": { + "/aggregate/customer-address": { + "post": { "tags": [ - "Guided Shopping Presentation" + "Customer Address" ], - "summary": "List with basic information of Guided Shopping Presentation resources.", - "description": "", - "operationId": "getGuidedShoppingPresentationList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "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 Guided Shopping Presentation resources.", + "description": "List of CustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -2495,41 +2058,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/guided-shopping-presentation?limit=25" - }, - "last": { - "example": "/guided-shopping-presentation?limit=25&page=11" - }, - "next": { - "example": "/guided-shopping-presentation?limit=25&page=4" - }, - "prev": { - "example": "/guided-shopping-presentation?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } } } } @@ -2546,7 +2078,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" + "$ref": "#/components/schemas/CustomerAddress" } } } @@ -2554,62 +2086,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/customer-group": { "post": { "tags": [ - "Presentation" - ], - "summary": "Create a new presentation", - "description": "", - "operationId": "createPresentation", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Customer Group" ], + "summary": "Aggregate for the Customer Group resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerGroup", "requestBody": { + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Presentation" + }, + "required": [ + "aggregations" + ] } } - }, - "required": false + } }, "responses": { "200": { - "description": "Detail of GuidedShoppingPresentation", + "description": "List of CustomerGroup", "content": { "application/vnd.api+json": { "schema": { @@ -2621,7 +2138,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } } } } @@ -2631,12 +2151,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } } } } @@ -2648,39 +2171,42 @@ }, "401": { "$ref": "#/components/responses/401" - }, - "204": { - "description": "" } } } }, - "/search/guided-shopping-presentation": { + "/aggregate/customer-recovery": { "post": { "tags": [ - "Presentation" + "Customer Recovery" ], - "summary": "Search presentations", - "description": "Return list of presentations", - "operationId": "searchPresentations", + "summary": "Aggregate for the Customer Recovery resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerRecovery", "requestBody": { - "required": false, + "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/GetListBodyRequest" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "", + "description": "List of CustomerRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -2694,7 +2220,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -2712,13 +2238,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Presentation" - } - }, - "aggregations": { - "type": "array", - "items": { - "type": "object" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -2732,33 +2252,41 @@ "401": { "$ref": "#/components/responses/401" } - }, - "parameters": [] + } } }, - "/guided-shopping-presentation/{id}": { - "get": { + "/aggregate/customer-wishlist": { + "post": { "tags": [ - "Guided Shopping Presentation" + "Customer Wishlist" ], - "summary": "Detailed information about a Guided Shopping Presentation resource.", - "description": "", - "operationId": "getGuidedShoppingPresentation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_presentation", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "Detail of GuidedShoppingPresentation", + "description": "List of CustomerWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -2770,7 +2298,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } } } } @@ -2780,124 +2311,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Guided Shopping Presentation" - ], - "summary": "Delete a Guided Shopping Presentation resource.", - "description": "", - "operationId": "deleteGuidedShoppingPresentation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_presentation", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/customer-wishlist-product": { + "post": { "tags": [ - "Guided Shopping Presentation" - ], - "summary": "Partially update information about a Guided Shopping Presentation resource.", - "description": "", - "operationId": "updateGuidedShoppingPresentation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_presentation", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Customer Wishlist Product" ], + "summary": "Aggregate for the Customer Wishlist Product resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerWishlistProduct", "requestBody": { - "description": "Partially update information about a Guided Shopping Presentation resource.", + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of GuidedShoppingPresentation", + "description": "List of CustomerWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -2909,7 +2378,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } } } } @@ -2919,12 +2391,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } } } } @@ -2934,52 +2409,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/guided-shopping-presentation-cms-page": { - "get": { + "/aggregate/delivery-time": { + "post": { "tags": [ - "Guided Shopping Presentation Cms Page" + "Delivery Time" ], - "summary": "List with basic information of Guided Shopping Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getGuidedShoppingPresentationCmsPageList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "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 Guided Shopping Presentation Cms Page resources.", + "description": "List of DeliveryTime", "content": { "application/vnd.api+json": { "schema": { @@ -2991,41 +2458,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/guided-shopping-presentation-cms-page?limit=25" - }, - "last": { - "example": "/guided-shopping-presentation-cms-page?limit=25&page=11" - }, - "next": { - "example": "/guided-shopping-presentation-cms-page?limit=25&page=4" - }, - "prev": { - "example": "/guided-shopping-presentation-cms-page?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryTime" + } } } } @@ -3042,7 +2478,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + "$ref": "#/components/schemas/DeliveryTime" } } } @@ -3050,61 +2486,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/document": { "post": { "tags": [ - "Guided Shopping Presentation Cms Page" - ], - "summary": "Create a new Guided Shopping Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createGuidedShoppingPresentationCmsPage", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Document" ], + "summary": "Aggregate for the Document resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocument", "requestBody": { + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of GuidedShoppingPresentationCmsPage", + "description": "List of Document", "content": { "application/vnd.api+json": { "schema": { @@ -3116,7 +2538,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } } } } @@ -3126,12 +2551,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } } } } @@ -3147,32 +2575,38 @@ } } }, - "/search/guided-shopping-presentation-cms-page": { + "/aggregate/document-base-config": { "post": { "tags": [ - "Guided Shopping Presentation Cms Page" + "Document Base Config" ], - "summary": "Search for the Guided Shopping Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchGuidedShoppingPresentationCmsPage", + "summary": "Aggregate for the Document Base Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocumentBaseConfig", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of GuidedShoppingPresentationCmsPage", + "description": "List of DocumentBaseConfig", "content": { "application/vnd.api+json": { "schema": { @@ -3186,7 +2620,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -3204,7 +2638,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -3221,29 +2655,38 @@ } } }, - "/guided-shopping-presentation-cms-page/{id}": { - "get": { + "/aggregate/document-base-config-sales-channel": { + "post": { "tags": [ - "Guided Shopping Presentation Cms Page" + "Document Base Config Sales Channel" ], - "summary": "Detailed information about a Guided Shopping Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getGuidedShoppingPresentationCmsPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_presentation_cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "Detail of GuidedShoppingPresentationCmsPage", + "description": "List of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -3255,7 +2698,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } } } } @@ -3265,124 +2711,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Guided Shopping Presentation Cms Page" - ], - "summary": "Delete a Guided Shopping Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteGuidedShoppingPresentationCmsPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_presentation_cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/document-type": { + "post": { "tags": [ - "Guided Shopping Presentation Cms Page" - ], - "summary": "Partially update information about a Guided Shopping Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateGuidedShoppingPresentationCmsPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_presentation_cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Document Type" ], + "summary": "Aggregate for the Document Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocumentType", "requestBody": { - "description": "Partially update information about a Guided Shopping Presentation Cms Page resource.", + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of GuidedShoppingPresentationCmsPage", + "description": "List of DocumentType", "content": { "application/vnd.api+json": { "schema": { @@ -3394,7 +2778,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } } } } @@ -3404,12 +2791,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } } } } @@ -3419,4463 +2809,8542 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/guided-shopping-presentation/{presentationId}": { - "get": { + "/aggregate/flow": { + "post": { "tags": [ - "Presentation" + "Flow" ], - "summary": "Get detail of presentation", - "description": "", - "operationId": "getPresentation", - "parameters": [ - { - "name": "presentationId", - "in": "path", - "description": "Presentation id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "", + "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": { - "$ref": "#/components/schemas/Presentation" + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } } } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/flow-sequence": { + "post": { "tags": [ - "Presentation" - ], - "summary": "Update partially the existing presentation", - "description": "", - "operationId": "updatePresentation", - "parameters": [ - { - "name": "presentationId", - "in": "path", - "description": "Presentation id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "Flow Sequence" ], + "summary": "Aggregate for the Flow Sequence resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateFlowSequence", "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Presentation" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, - "responses": { - "204": { - "description": "" - } - } - }, - "delete": { - "tags": [ - "Presentation" - ], - "summary": "Delete presentation", - "description": "", - "operationId": "deletePresentation", - "parameters": [ - { - "name": "presentationId", - "in": "path", - "description": "Presentation id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "204": { - "description": "" - } - } - } - }, - "/_action/guided-shopping/appointment/{appointmentId}/join-as-guide": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Join a meeting as a guide", - "description": "This route is used to join appointment as guide.", - "operationId": "joinAppointmentAsGuide", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], "responses": { "200": { - "description": "", + "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": { - "$ref": "#/components/schemas/JoinAppointmentResponse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/guided-shopping/appointment/{appointmentId}/start": { + "/aggregate/flow-template": { "post": { "tags": [ - "Appointment" - ], - "summary": "Start a presentation for a appointment", - "description": "Complete all needed data start the presentation", - "operationId": "startAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "Flow Template" ], + "summary": "Aggregate for the Flow Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateFlowTemplate", "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { + "type": "object", "properties": { - "attendeeIds": { + "aggregations": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "The attendee ids are waiting the appointment to start" + "$ref": "#/components/schemas/Aggregation" + } } - } + }, + "required": [ + "aggregations" + ] } } } }, - "responses": { - "204": { - "description": "" - } - } - } - }, - "/_action/guided-shopping/appointment/{appointmentId}/end": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "End a presentation for a appointment", - "description": "Complete all needed data and remove unneeded to close the presentation", - "operationId": "endAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/_action/guided-shopping/appointment/attendee/{attendeeId}/sw-context-token": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get the sw-context-token for a attendee", - "description": "Returns the context-token for the given attendee if the attendee granted the permission for the cart", - "operationId": "getAttendeeToken", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], "responses": { "200": { - "description": "The sw-context-token from the attendee", + "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": { - "attendee-sw-context-token": { - "type": "string" + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowTemplate" + } } - }, - "example": { - "attendee-sw-context-token": "context token of attendee" } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/guided-shopping/appointment/{appointmentId}/instant-listing": { + "/aggregate/import-export-file": { "post": { "tags": [ - "Appointment" - ], - "summary": "Add a instant listing to the presentation", - "description": "Add a page as the instant listing to the presentation", - "operationId": "addInstantListing", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "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": { - "required": [ - "productIds", - "currentPageGroupId" - ], + "type": "object", "properties": { - "productIds": { + "aggregations": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be added to the instant listing" - }, - "currentPageGroupId": { - "type": "string", - "description": "Id of the current cms page", - "pattern": "^[0-9a-f]{32}$" + "$ref": "#/components/schemas/Aggregation" + } } }, - "type": "object" + "required": [ + "aggregations" + ] } } } }, "responses": { - "201": { - "description": "Created a new instant listing", + "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": { - "index": { - "type": "integer", - "description": "The current index of the instant listing which is created by this request" + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportFile" + } } - }, - "example": { - "index": 1 } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/import-export-log": { + "post": { "tags": [ - "Appointment" - ], - "summary": "Update a instant listing from the presentation", - "description": "Updates the products for the given listing", - "operationId": "updateInstantListing", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "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": { - "required": [ - "addProductIds", - "removeProductIds", - "currentPageGroupId" - ], + "type": "object", "properties": { - "addProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be added to the instant listing" - }, - "removeProductIds": { + "aggregations": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be removed to the instant listing" - }, - "currentPageGroupId": { - "type": "string", - "description": "Id of the current cms page", - "pattern": "^[0-9a-f]{32}$" + "$ref": "#/components/schemas/Aggregation" + } } }, - "type": "object" + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Updated the instant listing", + "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": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the instant listing page" + "total": { + "type": "integer" }, - "pickedProductIds": { + "data": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which are picked for the instant listing" - }, - "title": { - "type": "string", - "description": "The title of the instant listing" + "$ref": "#/components/schemas/ImportExportLog" + } } - }, - "example": { - "id": "018c3e5ffd3a70899fa1321bf7e2a7f7", - "pickedProductIds": [ - "018c19b80403709cb2cef54f70860042", - "018c19b804027291955d8f076c272d0d" - ], - "title": "Default Digital Sales Rooms product listing page" } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/guided-shopping/appointment/{appointmentId}/presentation/state": { + "/aggregate/import-export-profile": { "post": { "tags": [ - "Appointment" + "Import Export Profile" ], - "summary": "Get the current presentation state", - "description": "Returns the presentation state for all and the guide", - "operationId": "getGuidePresentationState", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "", + "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": { - "$ref": "#/components/schemas/GuidePresentationStateResponse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/guided-shopping/appointment/{appointmentId}/video-room": { + "/aggregate/integration": { "post": { "tags": [ - "Appointment" + "Integration" ], - "summary": "Create a video room", - "description": "Creates a video room on the remote video tool", - "operationId": "createVideoRoom", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "", + "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": { - "$ref": "#/components/schemas/VideoChatCreateStruct" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + } } } } - } - } - }, - "delete": { - "tags": [ - "Appointment" - ], - "summary": "Delete a video room", - "description": "Delete a video room and tokens on the remote video tool", - "operationId": "deleteVideoRoom", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": [] - } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/guided-shopping/appointment/{appointmentId}/widgets/attendee-insights": { - "get": { + "/aggregate/landing-page": { + "post": { "tags": [ - "Appointment" + "Landing Page" ], - "summary": "Get attendee insights", - "description": "Get attendee insights for the given appointment", - "operationId": "getAttendeeInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "", + "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": { - "$ref": "#/components/schemas/GetAttendeeInsightsResponse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/guided-shopping/appointment/{appointmentId}/widgets/cart-insights": { - "get": { + "/aggregate/language": { + "post": { "tags": [ - "Appointment" + "Language" ], - "summary": "Get cart insights", - "description": "Get cart insights for the given appointment", - "operationId": "getCartInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "", + "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": { - "$ref": "#/components/schemas/GetCartInsightsResponse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/guided-shopping/appointment/{appointmentId}/widgets/cart-statistics": { - "get": { + "/aggregate/locale": { + "post": { "tags": [ - "Appointment" + "Locale" ], - "summary": "Get cart statistics", - "description": "Get cart statistics (cart line items) of all the attendees for the given appointment", - "operationId": "getCartStatistics", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "", + "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": { - "$ref": "#/components/schemas/Cart" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Locale" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/guided-shopping/appointment/{appointmentId}/widgets/last-seen": { - "get": { + "/aggregate/log-entry": { + "post": { "tags": [ - "Appointment" - ], - "summary": "Get last seen products insights", - "description": "Get last seen products of all attendees for the given appointment", - "operationId": "getLastSeenProductsInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "Log Entry" ], + "summary": "Aggregate for the Log Entry resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLogEntry", "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { + "type": "object", "properties": { - "limit": { - "type": "integer", - "description": "The limit of the products which should be returned", - "default": 10 - }, - "page": { - "type": "integer", - "description": "The page of the products which should be returned", - "default": 1 - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The attendee id for which the last seen products should be returned" + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } } - } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "", + "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": { - "$ref": "#/components/schemas/WidgetProductListing" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogEntry" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/guided-shopping/appointment/{appointmentId}/widgets/wishlist": { - "get": { + "/aggregate/mail-header-footer": { + "post": { "tags": [ - "Appointment" + "Mail Header Footer" ], - "summary": "Get wishlist insights", - "description": "Get wishlist of all the attendees for the given appointment", - "operationId": "getWishlistInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "", + "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": { - "$ref": "#/components/schemas/WidgetProductListing" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/guided-shopping-appointment/{appointmentId}": { - "get": { + "/aggregate/mail-template": { + "post": { "tags": [ - "Appointment" + "Mail Template" ], - "summary": "Get detail of appointment", - "description": "", - "operationId": "getAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "", + "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": { - "$ref": "#/components/schemas/Appointment" + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } } } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/mail-template-type": { + "post": { "tags": [ - "Appointment" - ], - "summary": "Update partially the existing appointment", - "description": "", - "operationId": "updateAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "Mail Template Type" ], + "summary": "Aggregate for the Mail Template Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMailTemplateType", "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Appointment" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { - "204": { - "description": "" + "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" } } - }, - "delete": { + } + }, + "/aggregate/main-category": { + "post": { "tags": [ - "Appointment" + "Main Category" ], - "summary": "Delete appointment", - "description": "", - "operationId": "deleteAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": { - "204": { - "description": "" + "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" } } } - } - }, - "components": { - "schemas": { - "success": { - "required": [ - "data" + }, + "/aggregate/media": { + "post": { + "tags": [ + "Media" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "description": "Link members related to the primary data.", - "allOf": [ - { - "$ref": "#/components/schemas/links" + "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" + } + } + } + } + ] + } }, - { - "$ref": "#/components/schemas/pagination" + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + } + } + } } - ] + } }, - "data": { - "$ref": "#/components/schemas/data" + "400": { + "$ref": "#/components/responses/400" }, - "included": { - "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object", - "additionalProperties": false - }, - "failure": { - "required": [ - "errors" + } + } + }, + "/aggregate/media-default-folder": { + "post": { + "tags": [ + "Media Default Folder" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/error" - }, - "uniqueItems": true + "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" + ] + } + } } }, - "type": "object", - "additionalProperties": false - }, - "info": { - "required": [ - "meta" - ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "$ref": "#/components/schemas/links" + "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" + } + } + } + } + } + } }, - "jsonapi": { - "$ref": "#/components/schemas/jsonapi" - } - }, - "type": "object" - }, - "meta": { - "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", - "type": "object", - "additionalProperties": true - }, - "data": { - "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", - "oneOf": [ - { - "$ref": "#/components/schemas/resource" + "400": { + "$ref": "#/components/responses/400" }, - { - "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "401": { + "$ref": "#/components/responses/401" } - ] - }, - "resource": { - "description": "\"Resource objects\" appear in a JSON API document to represent resources.", - "required": [ - "type", - "id" + } + } + }, + "/aggregate/media-folder": { + "post": { + "tags": [ + "Media Folder" ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string" - }, - "attributes": { - "$ref": "#/components/schemas/attributes" - }, - "relationships": { - "$ref": "#/components/schemas/relationships" - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "meta": { - "$ref": "#/components/schemas/meta" + "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" + ] + } + } } }, - "type": "object" - }, - "relationshipLinks": { - "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", - "properties": { - "self": { - "allOf": [ - { - "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", - "type": "array", - "items": { - "type": "object" + "responses": { + "200": { + "description": "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" + } + } + } + } + ] } }, - { - "$ref": "#/components/schemas/link" + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + } } - ] + } }, - "related": { - "$ref": "#/components/schemas/link" + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object", - "additionalProperties": true - }, - "links": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/link" } - }, - "link": { - "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", - "oneOf": [ - { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - { - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - "meta": { - "$ref": "#/components/schemas/meta" + } + }, + "/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" + ] } } } - ] - }, - "attributes": { - "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", - "type": "object", - "additionalProperties": true - }, - "relationships": { - "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", - "type": "object", - "anyOf": [ - { - "required": [ - "data" - ] - }, - { - "required": [ - "meta" - ] - }, - { - "required": [ - "links" - ] - }, - { - "type": "object", - "properties": { - "links": { - "$ref": "#/components/schemas/relationshipLinks" + }, + "responses": { + "200": { + "description": "List of MediaFolderConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + } + ] + } }, - "data": { - "description": "Member, whose value represents \"resource linkage\".", - "oneOf": [ - { - "$ref": "#/components/schemas/relationshipToOne" - }, - { - "$ref": "#/components/schemas/relationshipToMany" + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } } - ] + } } } - } - ], - "additionalProperties": false - }, - "relationshipToOne": { - "allOf": [ - { - "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." }, - { - "$ref": "#/components/schemas/linkage" + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } - ] - }, - "relationshipToMany": { - "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", - "type": "array", - "items": { - "$ref": "#/components/schemas/linkage" - }, - "uniqueItems": true - }, - "linkage": { - "description": "The \"type\" and \"id\" to non-empty members.", - "required": [ - "type", - "id" + } + } + }, + "/aggregate/media-thumbnail": { + "post": { + "tags": [ + "Media Thumbnail" ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "meta": { - "$ref": "#/components/schemas/meta" + "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" + ] + } + } } }, - "type": "object", - "additionalProperties": false - }, - "pagination": { - "properties": { - "first": { - "description": "The first page of data", - "type": "string", - "format": "uri-reference" - }, - "last": { - "description": "The last page of data", - "type": "string", - "format": "uri-reference" - }, - "prev": { - "description": "The previous page of data", - "type": "string", - "format": "uri-reference" + "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" + } + } + } + } + } + } }, - "next": { - "description": "The next page of data", - "type": "string", - "format": "uri-reference" - } - }, - "type": "object" - }, - "jsonapi": { - "description": "An object describing the server's implementation", - "properties": { - "version": { - "type": "string" + "400": { + "$ref": "#/components/responses/400" }, - "meta": { - "$ref": "#/components/schemas/meta" + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object", - "additionalProperties": false - }, - "error": { - "properties": { - "id": { - "type": "string", - "description": "A unique identifier for this particular occurrence of the problem." - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "status": { - "type": "string", - "description": "The HTTP status code applicable to this problem, expressed as a string value." - }, - "code": { - "type": "string", - "description": "An application-specific error code, expressed as a string value." - }, - "title": { - "type": "string", - "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization." - }, - "detail": { - "type": "string", - "description": "A human-readable explanation specific to this occurrence of the problem." - }, - "description": { - "type": "string", - "description": "A human-readable description of the problem." - }, - "source": { - "type": "object", - "properties": { - "pointer": { - "type": "string", - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]." - }, - "parameter": { - "type": "string", - "description": "A string indicating which query parameter caused the error." + } + } + }, + "/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" + ] } } - }, - "meta": { - "$ref": "#/components/schemas/meta" } }, - "type": "object", - "additionalProperties": false - }, - "AclRoleJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "privileges", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" + "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" + } + } + } + } + ] + } }, - "privileges": { - "type": "array", - "items": { + "application/json": { + "schema": { "type": "object", - "additionalProperties": false + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } } - }, - "deletedAt": { - "type": "string", - "format": "date-time" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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": { - "users": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/users" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "example": "9bc65c2abec141778ffaa729489f3e87" - } + "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" }, - "type": "object" - }, - "app": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/app" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" - } - } + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" - }, - "integrations": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/integrations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "integration" - }, - "id": { - "type": "string", - "example": "415320131958c70f4f250ca4d7e63bbd" - } + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" + } + } } - }, - "type": "object" + } } - }, - "type": "object" - } - ] - }, - "AclRole": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name", - "privileges", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "privileges": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false } }, - "deletedAt": { - "type": "string", - "format": "date-time" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "400": { + "$ref": "#/components/responses/400" }, - "users": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" + } + } + } + } + } } }, - "app": { - "$ref": "#/components/schemas/App" + "400": { + "$ref": "#/components/responses/400" }, - "integrations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Integration" + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" + ] + } } } }, - "type": "object" - }, - "AclUserRole": { - "description": "Added since version: 6.0.0.0", - "required": [ - "userId", - "aclRoleId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "aclRoleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" + } + } + } + } + } + } }, - "user": { - "$ref": "#/components/schemas/User" + "400": { + "$ref": "#/components/responses/400" }, - "aclRole": { - "$ref": "#/components/schemas/AclRole" + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object" - }, - "AppJsonApi": { - "description": "Added since version: 6.3.1.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "path", - "active", - "configurable", - "version", - "allowDisable", - "integrationId", - "aclRoleId", - "createdAt", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "author": { - "type": "string" - }, - "copyright": { - "type": "string" - }, - "license": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "configurable": { - "type": "boolean" - }, - "privacy": { - "type": "string" - }, - "version": { - "type": "string" - }, - "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "modules": { - "type": "array", - "items": { - "type": "object" - } - }, - "mainModule": { - "type": "object" - }, - "cookies": { - "type": "array", - "items": { - "type": "object" - } - }, - "allowDisable": { - "type": "boolean" - }, - "baseAppUrl": { - "type": "string" - }, - "allowedHosts": { - "type": "array", - "items": { - "type": "string" - } - }, - "templateLoadPriority": { - "type": "integer", - "format": "int64" - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "privacyPolicyExtensions": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "integrationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "aclRoleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { + } + } + }, + "/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": { - "integration": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/integration" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "integration" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "776ea3bf11df5829827f7afb43c37174" + "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" }, - "type": "object" - }, - "aclRole": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/aclRole" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "acl_role" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "250aa1c64b973365fd6fd489eefbdefc" - } - } + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeState" } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" - }, - "customFieldSets": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/customFieldSets" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_field_set" - }, - "id": { - "type": "string", - "example": "9b29ba872ce510f033b31364c8602760" - } + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" - }, - "actionButtons": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/actionButtons" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_action_button" - }, - "id": { - "type": "string", - "example": "2c7967427ed432e546ef1c0cb8d5da9e" - } - } - } + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" - }, - "templates": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/templates" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_template" - }, - "id": { - "type": "string", - "example": "fed36e93a0509e20f2dc96cbbd85b678" - } + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" - }, - "webhooks": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/webhooks" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "webhook" - }, - "id": { - "type": "string", - "example": "c10f40999b74c408263f790b30e70efe" - } - } - } + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" - }, - "paymentMethods": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/paymentMethods" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_payment_method" - }, - "id": { - "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" - } + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" - }, - "taxProviders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/taxProviders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tax_provider" - }, - "id": { - "type": "string", - "example": "01a1a9d428b6402dc8255d99c787a00e" - } - } - } + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" - }, - "cmsBlocks": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_cms_block" - }, - "id": { - "type": "string", - "example": "3636c4901eab836dfb837e1a9a37d3c0" - } + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" - }, - "flowActions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowActions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_flow_action" - }, - "id": { - "type": "string", - "example": "8d83a8af9d1b8b85dae9bdb76b7dbe7f" - } - } - } + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" - }, - "flowEvents": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowEvents" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_flow_event" - }, - "id": { - "type": "string", - "example": "045e9ec14eafd26d17854fb4fe7c9cae" - } + { + "type": "object", + "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" + } + } + } + }, + "/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" - }, - "appShippingMethods": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/appShippingMethods" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_shipping_method" - }, - "id": { - "type": "string", - "example": "1ad05ee47064647ee5b2dc8c12b1041c" - } + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } } - }, - "type": "object" + } } - }, - "type": "object" - } - ] - }, - "App": { - "description": "Added since version: 6.3.1.0", - "required": [ - "id", - "name", - "path", - "active", - "configurable", - "version", - "allowDisable", - "integrationId", - "aclRoleId", - "createdAt", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "path": { - "type": "string" - }, - "author": { - "type": "string" - }, - "copyright": { - "type": "string" - }, - "license": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "configurable": { - "type": "boolean" - }, - "privacy": { - "type": "string" - }, - "version": { - "type": "string" - }, - "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "modules": { - "type": "array", - "items": { - "type": "object" } }, - "mainModule": { - "type": "object" + "400": { + "$ref": "#/components/responses/400" }, - "cookies": { - "type": "array", - "items": { - "type": "object" + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" + ] + } } - }, - "allowDisable": { - "type": "boolean" - }, - "baseAppUrl": { - "type": "string" - }, - "allowedHosts": { - "type": "array", - "items": { - "type": "string" + } + }, + "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" + } + } + } + } + } } }, - "templateLoadPriority": { - "type": "integer", - "format": "int64" - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "privacyPolicyExtensions": { - "type": "string" + "400": { + "$ref": "#/components/responses/400" }, - "customFields": { - "type": "object" - }, - "integrationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "aclRoleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "integration": { - "$ref": "#/components/schemas/Integration" - }, - "aclRole": { - "$ref": "#/components/schemas/AclRole" - }, - "customFieldSets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSet" + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" + ] + } } - }, - "actionButtons": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppActionButton" + } + }, + "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" + } + } + } + } + } } }, - "templates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppTemplate" - } + "400": { + "$ref": "#/components/responses/400" }, - "webhooks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook" + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" + ] + } } - }, - "paymentMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppPaymentMethod" + } + }, + "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" + } + } + } + } + } } }, - "taxProviders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxProvider" - } + "400": { + "$ref": "#/components/responses/400" }, - "cmsBlocks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppCmsBlock" + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" + ] + } } - }, - "flowActions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowAction" + } + }, + "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" + } + } + } + } + } } }, - "flowEvents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowEvent" - } + "400": { + "$ref": "#/components/responses/400" }, - "appShippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" + ] + } } } }, - "type": "object" - }, - "AppActionButtonJsonApi": { - "description": "Added since version: 6.3.1.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "entity", - "view", - "url", - "action", - "appId", - "createdAt", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entity": { - "type": "string" - }, - "view": { - "type": "string" - }, - "url": { - "type": "string" - }, - "action": { - "type": "string" - }, - "label": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "app": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "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" }, - "type": "object" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } } - }, - "type": "object" + } } - }, - "type": "object" - } - ] - }, - "AppActionButton": { - "description": "Added since version: 6.3.1.0", - "required": [ - "id", - "entity", - "view", - "url", - "action", - "appId", - "createdAt", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entity": { - "type": "string" - }, - "view": { - "type": "string" - }, - "url": { - "type": "string" - }, - "action": { - "type": "string" - }, - "label": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + } }, - "translated": { - "type": "object" + "400": { + "$ref": "#/components/responses/400" }, - "app": { - "$ref": "#/components/schemas/App" + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" + ] + } + } } }, - "type": "object" - }, - "AppAdministrationSnippetJsonApi": { - "description": "Added since version: 6.4.15.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "value", - "appId", - "localeId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "value": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "localeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" + } + } + } + } + ] + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + } } - }, - "type": "object" - } - ] - }, - "AppAdministrationSnippet": { - "description": "Added since version: 6.4.15.0", - "required": [ - "id", - "value", - "appId", - "localeId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "value": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "localeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "400": { + "$ref": "#/components/responses/400" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object" - }, - "AppCmsBlockJsonApi": { - "description": "Added since version: 6.4.2.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "block", - "template", - "styles", - "appId", - "createdAt", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "block": { - "type": "object" - }, - "template": { - "type": "string" - }, - "styles": { - "type": "string" - }, - "label": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { + } + } + }, + "/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": { - "app": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "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" }, - "type": "object" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } } - }, - "type": "object" + } } - }, - "type": "object" - } - ] - }, - "AppCmsBlock": { - "description": "Added since version: 6.4.2.0", - "required": [ - "id", - "name", - "block", - "template", - "styles", - "appId", - "createdAt", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "block": { - "type": "object" - }, - "template": { - "type": "string" - }, - "styles": { - "type": "string" - }, - "label": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + } }, - "translated": { - "type": "object" + "400": { + "$ref": "#/components/responses/400" }, - "app": { - "$ref": "#/components/schemas/App" + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object" - }, - "AppFlowActionJsonApi": { - "description": "Added since version: 6.4.10.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "appId", - "name", - "url", - "createdAt", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "badge": { - "type": "string" - }, - "parameters": { - "type": "object" - }, - "config": { - "type": "object" - }, - "headers": { - "type": "object" - }, - "requirements": { - "type": "array", - "items": { - "type": "string" - } - }, - "iconRaw": { - "type": "string" - }, - "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "swIcon": { - "type": "string" - }, - "url": { - "type": "string" - }, - "delayable": { - "type": "boolean" - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "headline": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { + } + } + }, + "/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": { - "app": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" - } - } - } + "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" - }, - "flowSequences": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow_sequence" - }, - "id": { - "type": "string", - "example": "3a0d70b6dd3624074e5e15cd07e7fa90" - } + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" + } + } } - }, - "type": "object" + } } - }, - "type": "object" - } - ] - }, - "AppFlowAction": { - "description": "Added since version: 6.4.10.0", - "required": [ - "id", - "appId", - "name", - "url", - "createdAt", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + } }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "400": { + "$ref": "#/components/responses/400" }, - "name": { - "type": "string" - }, - "badge": { - "type": "string" - }, - "parameters": { - "type": "object" - }, - "config": { - "type": "object" - }, - "headers": { - "type": "object" - }, - "requirements": { - "type": "array", - "items": { - "type": "string" - } - }, - "iconRaw": { - "type": "string" - }, - "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "swIcon": { - "type": "string" - }, - "url": { - "type": "string" - }, - "delayable": { - "type": "boolean" - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "headline": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "app": { - "$ref": "#/components/schemas/App" - }, - "flowSequences": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" + ] + } } } }, - "type": "object" - }, - "AppFlowEventJsonApi": { - "description": "Added since version: 6.5.2.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "appId", - "name", - "aware", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "aware": { - "type": "array", - "items": { - "type": "string" - } - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "app": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" - } - } - } + "responses": { + "200": { + "description": "List of Product", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "type": "object" - }, - "flows": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow" - }, - "id": { - "type": "string", - "example": "0db2dd944f9ee9a131f44b79d331d371" - } + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } } - }, - "type": "object" + } } - }, - "type": "object" - } - ] - }, - "AppFlowEvent": { - "description": "Added since version: 6.5.2.0", - "required": [ - "id", - "appId", - "name", - "aware", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "aware": { - "type": "array", - "items": { - "type": "string" } }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "app": { - "$ref": "#/components/schemas/App" + "400": { + "$ref": "#/components/responses/400" }, - "flows": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Flow" + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" + ] + } } } }, - "type": "object" - }, - "AppPaymentMethodJsonApi": { - "description": "Added since version: 6.4.1.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "appName", - "identifier", - "paymentMethodId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appName": { - "type": "string" - }, - "identifier": { - "type": "string" - }, - "payUrl": { - "type": "string" - }, - "finalizeUrl": { - "type": "string" - }, - "validateUrl": { - "type": "string" - }, - "captureUrl": { - "type": "string" - }, - "refundUrl": { - "type": "string" - }, - "recurringUrl": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "originalMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "paymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "app": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/app" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" - } - } - } + "responses": { + "200": { + "description": "List of ProductConfiguratorSetting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "type": "object" - }, - "originalMedia": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/originalMedia" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "56386c66f82d9cd5639a5a7447971ead" + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" - }, - "paymentMethod": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/paymentMethod" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "payment_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "68ec1eeea9f1b7744e231b5bd0d97df0" - } - } + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" } - }, - "type": "object" + } } - }, - "type": "object" + } } - }, - "type": "object" - } - ] - }, - "AppPaymentMethod": { - "description": "Added since version: 6.4.1.0", - "required": [ - "id", - "appName", - "identifier", - "paymentMethodId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appName": { - "type": "string" - }, - "identifier": { - "type": "string" - }, - "payUrl": { - "type": "string" - }, - "finalizeUrl": { - "type": "string" + } }, - "validateUrl": { - "type": "string" + "400": { + "$ref": "#/components/responses/400" }, - "captureUrl": { - "type": "string" - }, - "refundUrl": { - "type": "string" - }, - "recurringUrl": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "originalMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "paymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "app": { - "$ref": "#/components/schemas/App" - }, - "originalMedia": { - "$ref": "#/components/schemas/Media" - }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object" - }, - "AppScriptConditionJsonApi": { - "description": "Added since version: 6.4.10.3", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "identifier", - "active", - "appId", - "createdAt", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "identifier": { - "type": "string" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "group": { - "type": "string" - }, - "script": { - "type": "string" - }, - "config": { - "type": "object" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { + } + } + }, + "/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": { - "app": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" - } - } - } + "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" - }, - "ruleConditions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/ruleConditions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "rule_condition" - }, - "id": { - "type": "string", - "example": "24bfabce4195894c9aed9b8bcfb0b748" - } + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } } - }, - "type": "object" + } } - }, - "type": "object" - } - ] - }, - "AppScriptCondition": { - "description": "Added since version: 6.4.10.3", - "required": [ - "id", - "identifier", - "active", - "appId", - "createdAt", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "identifier": { - "type": "string" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "group": { - "type": "string" - }, - "script": { - "type": "string" - }, - "config": { - "type": "object" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" + } }, - "app": { - "$ref": "#/components/schemas/App" + "400": { + "$ref": "#/components/responses/400" }, - "ruleConditions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RuleCondition" + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" + ] + } } } }, - "type": "object" - }, - "AppShippingMethodJsonApi": { - "description": "Added since version: 6.5.7.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "appName", - "identifier", - "shippingMethodId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appName": { - "type": "string" - }, - "identifier": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "originalMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "app": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/app" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" - } - } - } + "responses": { + "200": { + "description": "List of ProductCrossSellingAssignedProducts", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "type": "object" - }, - "shippingMethod": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/shippingMethod" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "shipping_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" - }, - "originalMedia": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/originalMedia" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "56386c66f82d9cd5639a5a7447971ead" - } - } + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } - }, - "type": "object" + } } - }, - "type": "object" + } } - }, - "type": "object" - } - ] - }, - "AppShippingMethod": { - "description": "Added since version: 6.5.7.0", - "required": [ - "id", - "appName", - "identifier", - "shippingMethodId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appName": { - "type": "string" - }, - "identifier": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "originalMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "app": { - "$ref": "#/components/schemas/App" + } }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "400": { + "$ref": "#/components/responses/400" }, - "originalMedia": { - "$ref": "#/components/schemas/Media" + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object" - }, - "AppTemplateJsonApi": { - "description": "Added since version: 6.3.1.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + } + } + } }, - { - "required": [ - "id", - "template", - "path", - "active", - "appId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" + } + } + } + } + ] + } }, - "template": { - "type": "string" + "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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + }, + "/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" + } + } + } + } + ] + } }, - "path": { - "type": "string" + "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" + } + } + } + }, + "/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" + } + } + } + } + ] + } }, - "active": { - "type": "boolean" + "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" + } + } + } + }, + "/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" + } + } + } + } + ] + } }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" + } + } + } + }, + "/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" + } + } + } + } + ] + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" + } + } + } + }, + "/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" + } + } + } + } + ] + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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" + } + } + } + }, + "/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" + } + } + } + } + ] + } }, - "relationships": { + "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" + } + } + } + }, + "/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": { - "app": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-template/ca9106b8b82ff55b6fdce530ccb952a7/app" + "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" } } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + ] + } + }, + "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" + } + } + } + }, + "/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" }, - "type": "object" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } } - }, - "type": "object" + } } - }, - "type": "object" - } - ] - }, - "AppTemplate": { - "description": "Added since version: 6.3.1.0", - "required": [ - "id", - "template", - "path", - "active", - "appId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "template": { - "type": "string" - }, - "path": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "400": { + "$ref": "#/components/responses/400" }, - "app": { - "$ref": "#/components/schemas/App" + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object" - }, - "CategoryJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "displayNestedProducts", - "type", - "productAssignmentType", - "createdAt", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "afterCategoryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "afterCategoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "displayNestedProducts": { - "type": "boolean" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "breadcrumb": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - }, - "readOnly": true - }, - "level": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "path": { - "type": "string", - "readOnly": true - }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "type": { - "type": "string" - }, - "productAssignmentType": { - "type": "string" - }, - "visible": { - "type": "boolean" - }, - "active": { - "type": "boolean" - }, - "cmsPageIdSwitched": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "visibleChildCount": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" - }, - "linkType": { - "type": "string" - }, - "internalLink": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "externalLink": { - "type": "string" - }, - "linkNewTab": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "metaTitle": { - "type": "string" - }, - "metaDescription": { - "type": "string" - }, - "keywords": { - "type": "string" - }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customEntityTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { + } + } + }, + "/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": { - "parent": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/parent" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "category" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "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" }, - "type": "object" - }, - "children": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/children" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "category" - }, - "id": { - "type": "string", - "example": "268184c12df027f536154d099d497b31" - } - } - } + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" - }, - "media": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/media" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" - }, - "products": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/products" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "86024cad1e83101d97359d7351051156" - } + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" }, - "type": "object" - }, - "nestedProducts": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/nestedProducts" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "cf73cebf9ade7f94deba94ec71e66e43" - } - } - } + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" - }, - "tags": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/tags" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tag" - }, - "id": { - "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" - } + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" - }, - "cmsPage": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/cmsPage" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" - } - } + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/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" - }, - "productStream": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/productStream" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_stream" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "49561f6faa0badfce831a183d2ec7c2f" + { + "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" + } + } + } + }, + "/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" - }, - "navigationSalesChannels": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/navigationSalesChannels" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "04db458d860e0a4b455ae14b384a5e8a" - } + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" - }, - "footerSalesChannels": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/footerSalesChannels" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "57944aba1f6dea7ca9dacf66776e1755" - } - } - } + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/webhook-event-log": { + "post": { + "tags": [ + "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": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of WebhookEventLog", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "type": "object" - }, - "serviceSalesChannels": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/serviceSalesChannels" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "1a79932fadba3b20baf6369181e45602" - } + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" } } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" - }, - "mainCategories": { - "properties": { - "links": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/_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": { + "type": "array", + "items": { "type": "object", "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/mainCategories" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "main_category" - }, - "id": { - "type": "string", - "example": "1fb731fc4139cbb575429e28846f0c39" + "name": { + "type": "string" + }, + "healthy": { + "type": "boolean" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "extra": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true } } } } - }, - "type": "object" + } + } + } + } + } + }, + "500": { + "description": "Application is not working properly" + } + } + } + }, + "/_action/cache-delayed": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear all invalidated caches", + "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", + "operationId": "clearCacheDelayed", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." + } + } + } + }, + "/_proxy/generate-imitate-customer-token": { + "post": { + "tags": [ + "Customer impersonation" + ], + "summary": "Generate a customer impersonation token", + "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", + "operationId": "generateImitateCustomerToken", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "customerId", + "salesChannelId" + ], + "properties": { + "customerId": { + "description": "ID of the customer", + "type": "string" }, - "seoUrls": { - "properties": { - "links": { + "salesChannelId": { + "description": "ID of the sales channel", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The generated customer impersonation token.", + "content": { + "application/json": { + "schema": { + "properties": { + "token": { + "description": "The generated customer impersonation token", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_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": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/seoUrls" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "seo_url" - }, - "id": { - "type": "string", - "example": "5321b5a71127b8b98cdd4b068ad56c4c" + "methods": { + "type": "array", + "items": { + "type": "string" } + }, + "path": { + "type": "string" } } } - }, - "type": "object" + } } - }, - "type": "object" + } } - }, - "type": "object" + } } - ] - }, - "Category": { - "description": "Added since version: 6.0.0.0", + } + } + } + }, + "components": { + "schemas": { + "success": { "required": [ - "id", - "displayNestedProducts", - "type", - "productAssignmentType", - "createdAt", - "name" + "data" ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "afterCategoryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "meta": { + "$ref": "#/components/schemas/meta" }, - "afterCategoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "links": { + "description": "Link members related to the primary data.", + "allOf": [ + { + "$ref": "#/components/schemas/links" + }, + { + "$ref": "#/components/schemas/pagination" + } + ] }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "data": { + "$ref": "#/components/schemas/data" }, - "displayNestedProducts": { - "type": "boolean" + "included": { + "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + }, + "type": "object", + "additionalProperties": false + }, + "failure": { + "required": [ + "errors" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true + "links": { + "$ref": "#/components/schemas/links" }, - "breadcrumb": { + "errors": { "type": "array", "items": { - "type": "object", - "additionalProperties": false + "$ref": "#/components/schemas/error" }, - "readOnly": true - }, - "level": { - "type": "integer", - "format": "int64", - "readOnly": true + "uniqueItems": true + } + }, + "type": "object", + "additionalProperties": false + }, + "info": { + "required": [ + "meta" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" }, - "path": { - "type": "string", - "readOnly": true + "links": { + "$ref": "#/components/schemas/links" }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true + "jsonapi": { + "$ref": "#/components/schemas/jsonapi" + } + }, + "type": "object" + }, + "meta": { + "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", + "type": "object", + "additionalProperties": true + }, + "data": { + "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", + "oneOf": [ + { + "$ref": "#/components/schemas/resource" }, + { + "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + ] + }, + "resource": { + "description": "\"Resource objects\" appear in a JSON API document to represent resources.", + "required": [ + "type", + "id" + ], + "properties": { "type": { "type": "string" }, - "productAssignmentType": { - "type": "string" - }, - "visible": { - "type": "boolean" - }, - "active": { - "type": "boolean" - }, - "cmsPageIdSwitched": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "visibleChildCount": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" - }, - "linkType": { - "type": "string" - }, - "internalLink": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "externalLink": { - "type": "string" - }, - "linkNewTab": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "metaTitle": { - "type": "string" - }, - "metaDescription": { - "type": "string" - }, - "keywords": { + "id": { "type": "string" }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "attributes": { + "$ref": "#/components/schemas/attributes" }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "relationships": { + "$ref": "#/components/schemas/relationships" }, - "customEntityTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "links": { + "$ref": "#/components/schemas/links" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object" + }, + "relationshipLinks": { + "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", + "properties": { + "self": { + "allOf": [ + { + "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", + "type": "array", + "items": { + "type": "object" + } + }, + { + "$ref": "#/components/schemas/link" + } + ] }, - "updatedAt": { + "related": { + "$ref": "#/components/schemas/link" + } + }, + "type": "object", + "additionalProperties": true + }, + "links": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/link" + } + }, + "link": { + "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", + "oneOf": [ + { + "description": "A string containing the link's URL.", "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "parent": { - "$ref": "#/components/schemas/Category" + "format": "uri-reference" }, - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" + { + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" + }, + "meta": { + "$ref": "#/components/schemas/meta" + } } + } + ] + }, + "attributes": { + "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", + "type": "object", + "additionalProperties": true + }, + "relationships": { + "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", + "type": "object", + "anyOf": [ + { + "required": [ + "data" + ] }, - "media": { - "$ref": "#/components/schemas/Media" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } + { + "required": [ + "meta" + ] }, - "nestedProducts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } + { + "required": [ + "links" + ] }, - "tags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" + { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/relationshipLinks" + }, + "data": { + "description": "Member, whose value represents \"resource linkage\".", + "oneOf": [ + { + "$ref": "#/components/schemas/relationshipToOne" + }, + { + "$ref": "#/components/schemas/relationshipToMany" + } + ] + } } + } + ], + "additionalProperties": false + }, + "relationshipToOne": { + "allOf": [ + { + "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" - }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" + { + "$ref": "#/components/schemas/linkage" + } + ] + }, + "relationshipToMany": { + "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", + "type": "array", + "items": { + "$ref": "#/components/schemas/linkage" + }, + "uniqueItems": true + }, + "linkage": { + "description": "The \"type\" and \"id\" to non-empty members.", + "required": [ + "type", + "id" + ], + "properties": { + "type": { + "type": "string" }, - "navigationSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "footerSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object", + "additionalProperties": false + }, + "pagination": { + "properties": { + "first": { + "description": "The first page of data", + "type": "string", + "format": "uri-reference" }, - "serviceSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "last": { + "description": "The last page of data", + "type": "string", + "format": "uri-reference" }, - "mainCategories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } + "prev": { + "description": "The previous page of data", + "type": "string", + "format": "uri-reference" }, - "seoUrls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } + "next": { + "description": "The next page of data", + "type": "string", + "format": "uri-reference" } }, "type": "object" }, - "CategoryTag": { - "description": "Added since version: 6.0.0.0", - "required": [ - "categoryId", - "tagId" - ], + "jsonapi": { + "description": "An object describing the server's implementation", + "properties": { + "version": { + "type": "string" + }, + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object", + "additionalProperties": false + }, + "error": { "properties": { "id": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "A unique identifier for this particular occurrence of the problem." }, - "categoryId": { + "links": { + "$ref": "#/components/schemas/links" + }, + "status": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "The HTTP status code applicable to this problem, expressed as a string value." }, - "categoryVersionId": { + "code": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "An application-specific error code, expressed as a string value." }, - "tagId": { + "title": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization." }, - "category": { - "$ref": "#/components/schemas/Category" + "detail": { + "type": "string", + "description": "A human-readable explanation specific to this occurrence of the problem." }, - "tag": { - "$ref": "#/components/schemas/Tag" + "description": { + "type": "string", + "description": "A human-readable description of the problem." + }, + "source": { + "type": "object", + "properties": { + "pointer": { + "type": "string", + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]." + }, + "parameter": { + "type": "string", + "description": "A string indicating which query parameter caused the error." + } + } + }, + "meta": { + "$ref": "#/components/schemas/meta" } }, - "type": "object" + "type": "object", + "additionalProperties": false }, - "CmsBlockJsonApi": { + "AclRoleJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -7884,85 +11353,29 @@ { "required": [ "id", - "position", - "type", - "sectionId", - "createdAt" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "position": { - "type": "integer", - "format": "int64" - }, - "type": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, "name": { "type": "string" }, - "sectionPosition": { - "type": "string" - }, - "marginTop": { - "type": "string" - }, - "marginBottom": { - "type": "string" - }, - "marginLeft": { - "type": "string" - }, - "marginRight": { - "type": "string" - }, - "backgroundColor": { - "type": "string" - }, - "backgroundMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "backgroundMediaMode": { - "type": "string" - }, - "cssClass": { + "description": { "type": "string" }, - "visibility": { - "properties": { - "mobile": { - "type": "boolean" - }, - "desktop": { - "type": "boolean" - }, - "tablet": { - "type": "boolean" - } - }, - "type": "object" - }, - "sectionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFields": { - "type": "object" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "privileges": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } }, - "cmsSectionVersionId": { + "deletedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, "createdAt": { "type": "string", @@ -7976,7 +11389,7 @@ }, "relationships": { "properties": { - "section": { + "users": { "properties": { "links": { "type": "object", @@ -7984,28 +11397,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/section" + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/users" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_section" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "73d5342eba070f636ac3246f319bf77f" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "example": "9bc65c2abec141778ffaa729489f3e87" + } } } } }, "type": "object" }, - "backgroundMedia": { + "app": { "properties": { "links": { "type": "object", @@ -8013,7 +11428,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/backgroundMedia" + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/app" } } }, @@ -8022,19 +11437,19 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "9f63714a30b4d0292695bd4d27235a0b" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "slots": { + "integrations": { "properties": { "links": { "type": "object", @@ -8042,7 +11457,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/slots" + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/integrations" } } }, @@ -8053,11 +11468,11 @@ "properties": { "type": { "type": "string", - "example": "cms_slot" + "example": "integration" }, "id": { "type": "string", - "example": "a8b72798beb911ae98c8c8907d45950a" + "example": "415320131958c70f4f250ca4d7e63bbd" } } } @@ -8073,87 +11488,78 @@ } ] }, - "CmsBlock": { + "AclRole": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "position", - "type", - "sectionId", - "createdAt" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "position": { - "type": "integer", - "format": "int64" - }, - "type": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, "name": { "type": "string" }, - "sectionPosition": { - "type": "string" - }, - "marginTop": { - "type": "string" - }, - "marginBottom": { - "type": "string" - }, - "marginLeft": { + "description": { "type": "string" }, - "marginRight": { - "type": "string" + "privileges": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } }, - "backgroundColor": { - "type": "string" + "deletedAt": { + "type": "string", + "format": "date-time" }, - "backgroundMediaId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "backgroundMediaMode": { - "type": "string" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "cssClass": { - "type": "string" + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } }, - "visibility": { - "properties": { - "mobile": { - "type": "boolean" - }, - "desktop": { - "type": "boolean" - }, - "tablet": { - "type": "boolean" - } - }, - "type": "object" + "app": { + "$ref": "#/components/schemas/App" }, - "sectionId": { + "integrations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + }, + "type": "object" + }, + "AclUserRole": { + "description": "Added since version: 6.0.0.0", + "required": [ + "userId", + "aclRoleId" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" - }, - "versionId": { + "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsSectionVersionId": { + "aclRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8167,23 +11573,17 @@ "format": "date-time", "readOnly": true }, - "section": { - "$ref": "#/components/schemas/CmsSection" - }, - "backgroundMedia": { - "$ref": "#/components/schemas/Media" + "user": { + "$ref": "#/components/schemas/User" }, - "slots": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSlot" - } + "aclRole": { + "$ref": "#/components/schemas/AclRole" } }, "type": "object" }, - "CmsPageJsonApi": { - "description": "Added since version: 6.0.0.0", + "AppJsonApi": { + "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -8191,47 +11591,115 @@ { "required": [ "id", - "type", - "createdAt" + "name", + "path", + "version", + "integrationId", + "aclRoleId", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "author": { + "type": "string" + }, + "copyright": { + "type": "string" + }, + "license": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "configurable": { + "type": "boolean" + }, + "privacy": { + "type": "string" + }, + "version": { + "type": "string" + }, + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "name": { + "modules": { + "type": "array", + "items": { + "type": "object" + } + }, + "mainModule": { + "type": "object" + }, + "cookies": { + "type": "array", + "items": { + "type": "object" + } + }, + "allowDisable": { + "type": "boolean" + }, + "baseAppUrl": { "type": "string" }, - "type": { + "allowedHosts": { + "type": "array", + "items": { + "type": "string" + } + }, + "templateLoadPriority": { + "type": "integer", + "format": "int64" + }, + "checkoutGatewayUrl": { "type": "string" }, - "entity": { + "inAppPurchasesGatewayUrl": { "type": "string" }, - "cssClass": { + "sourceType": { "type": "string" }, - "config": { - "properties": { - "backgroundColor": { - "type": "string" - } - }, + "sourceConfig": { "type": "object" }, - "previewMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "selfManaged": { + "type": "boolean" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacyPolicyExtensions": { + "type": "string" }, "customFields": { "type": "object" }, - "locked": { - "type": "boolean" + "integrationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -8246,9 +11714,67 @@ "translated": { "type": "object" }, - "extensions": { + "relationships": { "properties": { - "createdBy": { + "integration": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/integration" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "776ea3bf11df5829827f7afb43c37174" + } + } + } + }, + "type": "object" + }, + "aclRole": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/aclRole" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "acl_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "250aa1c64b973365fd6fd489eefbdefc" + } + } + } + }, + "type": "object" + }, + "customFieldSets": { "properties": { "links": { "type": "object", @@ -8256,33 +11782,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/createdBy" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/customFieldSets" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set" + }, + "id": { + "type": "string", + "example": "9b29ba872ce510f033b31364c8602760" + } + } + } + } + }, + "type": "object" + }, + "actionButtons": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/actionButtons" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_action_button" + }, + "id": { + "type": "string", + "example": "2c7967427ed432e546ef1c0cb8d5da9e" + } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "sections": { + }, + "templates": { "properties": { "links": { "type": "object", @@ -8290,7 +11844,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/sections" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/templates" } } }, @@ -8301,11 +11855,11 @@ "properties": { "type": { "type": "string", - "example": "cms_section" + "example": "app_template" }, "id": { "type": "string", - "example": "ff4dee88db82e98f0e0d524d965b9aa7" + "example": "fed36e93a0509e20f2dc96cbbd85b678" } } } @@ -8313,7 +11867,7 @@ }, "type": "object" }, - "previewMedia": { + "webhooks": { "properties": { "links": { "type": "object", @@ -8321,28 +11875,92 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/previewMedia" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/webhooks" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "webhook" + }, + "id": { + "type": "string", + "example": "c10f40999b74c408263f790b30e70efe" + } + } + } + } + }, + "type": "object" + }, + "paymentMethods": { + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "media" - }, - "id": { + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/paymentMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_payment_method" + }, + "id": { + "type": "string", + "example": "b631b1ab565525e892f9cdc1242cca14" + } + } + } + } + }, + "type": "object" + }, + "taxProviders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "a7a817fb0e422cff87e878b8ff7ca914" + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/taxProviders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_provider" + }, + "id": { + "type": "string", + "example": "01a1a9d428b6402dc8255d99c787a00e" + } } } } }, "type": "object" }, - "categories": { + "cmsBlocks": { "properties": { "links": { "type": "object", @@ -8350,7 +11968,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/categories" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" } } }, @@ -8361,11 +11979,11 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "app_cms_block" }, "id": { "type": "string", - "example": "b0b5ccb4a195a07fd3eed14affb8695f" + "example": "3636c4901eab836dfb837e1a9a37d3c0" } } } @@ -8373,7 +11991,7 @@ }, "type": "object" }, - "landingPages": { + "flowActions": { "properties": { "links": { "type": "object", @@ -8381,7 +11999,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/landingPages" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowActions" } } }, @@ -8392,11 +12010,11 @@ "properties": { "type": { "type": "string", - "example": "landing_page" + "example": "app_flow_action" }, "id": { "type": "string", - "example": "d60b77f2b3bd69591e3d5e3100926b4d" + "example": "8d83a8af9d1b8b85dae9bdb76b7dbe7f" } } } @@ -8404,7 +12022,7 @@ }, "type": "object" }, - "homeSalesChannels": { + "flowEvents": { "properties": { "links": { "type": "object", @@ -8412,7 +12030,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/homeSalesChannels" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowEvents" } } }, @@ -8423,11 +12041,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "app_flow_event" }, "id": { "type": "string", - "example": "9aed0c38161f67f2d40a4a872cae045f" + "example": "045e9ec14eafd26d17854fb4fe7c9cae" } } } @@ -8435,7 +12053,7 @@ }, "type": "object" }, - "products": { + "appShippingMethods": { "properties": { "links": { "type": "object", @@ -8443,7 +12061,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/products" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/appShippingMethods" } } }, @@ -8454,11 +12072,11 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "app_shipping_method" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "1ad05ee47064647ee5b2dc8c12b1041c" } } } @@ -8474,51 +12092,119 @@ } ] }, - "CmsPage": { - "description": "Added since version: 6.0.0.0", + "App": { + "description": "Added since version: 6.3.1.0", "required": [ "id", - "type", - "createdAt" + "name", + "path", + "version", + "integrationId", + "aclRoleId", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "author": { + "type": "string" + }, + "copyright": { + "type": "string" + }, + "license": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "configurable": { + "type": "boolean" + }, + "privacy": { + "type": "string" + }, + "version": { + "type": "string" + }, + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "name": { + "modules": { + "type": "array", + "items": { + "type": "object" + } + }, + "mainModule": { + "type": "object" + }, + "cookies": { + "type": "array", + "items": { + "type": "object" + } + }, + "allowDisable": { + "type": "boolean" + }, + "baseAppUrl": { "type": "string" }, - "type": { + "allowedHosts": { + "type": "array", + "items": { + "type": "string" + } + }, + "templateLoadPriority": { + "type": "integer", + "format": "int64" + }, + "checkoutGatewayUrl": { "type": "string" }, - "entity": { + "inAppPurchasesGatewayUrl": { "type": "string" }, - "cssClass": { + "sourceType": { "type": "string" }, - "config": { - "properties": { - "backgroundColor": { - "type": "string" - } - }, + "sourceConfig": { "type": "object" }, - "previewMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "selfManaged": { + "type": "boolean" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacyPolicyExtensions": { + "type": "string" }, "customFields": { "type": "object" }, - "locked": { - "type": "boolean" + "integrationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -8533,78 +12219,77 @@ "translated": { "type": "object" }, - "extensions": { - "properties": { - "createdBy": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/createdBy" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" - } - } - } - }, - "type": "object" - } - }, - "type": "object" + "integration": { + "$ref": "#/components/schemas/Integration" }, - "sections": { + "aclRole": { + "$ref": "#/components/schemas/AclRole" + }, + "customFieldSets": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CustomFieldSet" } }, - "previewMedia": { - "$ref": "#/components/schemas/Media" + "actionButtons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" + } }, - "categories": { + "templates": { "type": "array", "items": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/AppTemplate" } }, - "landingPages": { + "webhooks": { "type": "array", "items": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Webhook" } }, - "homeSalesChannels": { + "paymentMethods": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/AppPaymentMethod" } }, - "products": { + "taxProviders": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/TaxProvider" + } + }, + "cmsBlocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } + }, + "flowActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } + }, + "flowEvents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } + }, + "appShippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" } } }, "type": "object" }, - "CmsSectionJsonApi": { - "description": "Added since version: 6.0.0.0", + "AppActionButtonJsonApi": { + "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -8612,72 +12297,34 @@ { "required": [ "id", - "position", - "type", - "pageId", - "createdAt", - "name" + "entity", + "view", + "url", + "action", + "appId", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "position": { - "type": "integer", - "format": "int64" - }, - "type": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "sizingMode": { + "entity": { "type": "string" }, - "mobileBehavior": { + "view": { "type": "string" }, - "backgroundColor": { + "url": { "type": "string" }, - "backgroundMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "backgroundMediaMode": { + "action": { "type": "string" }, - "cssClass": { + "label": { "type": "string" }, - "pageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "visibility": { - "properties": { - "mobile": { - "type": "boolean" - }, - "desktop": { - "type": "boolean" - }, - "tablet": { - "type": "boolean" - } - }, - "type": "object" - }, - "customFields": { - "type": "object" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8696,36 +12343,7 @@ }, "relationships": { "properties": { - "page": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/page" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "71860c77c6745379b0d44304d66b6a13" - } - } - } - }, - "type": "object" - }, - "backgroundMedia": { + "app": { "properties": { "links": { "type": "object", @@ -8733,7 +12351,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/backgroundMedia" + "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" } } }, @@ -8742,43 +12360,12 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "9f63714a30b4d0292695bd4d27235a0b" - } - } - } - }, - "type": "object" - }, - "blocks": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/blocks" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_block" - }, - "id": { - "type": "string", - "example": "e734964953f880e5164e32827950ff92" - } + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } @@ -8793,76 +12380,125 @@ } ] }, - "CmsSection": { - "description": "Added since version: 6.0.0.0", + "AppActionButton": { + "description": "Added since version: 6.3.1.0", "required": [ "id", - "position", - "type", - "pageId", - "createdAt", - "name" + "entity", + "view", + "url", + "action", + "appId", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "position": { - "type": "integer", - "format": "int64" - }, - "type": { + "entity": { "type": "string" }, - "locked": { - "type": "boolean" + "view": { + "type": "string" }, - "sizingMode": { + "url": { "type": "string" }, - "mobileBehavior": { + "action": { "type": "string" }, - "backgroundColor": { + "label": { "type": "string" }, - "backgroundMediaId": { + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "backgroundMediaMode": { - "type": "string" - }, - "cssClass": { - "type": "string" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "pageId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "visibility": { + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "AppAdministrationSnippetJsonApi": { + "description": "Added since version: 6.4.15.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "value", + "appId", + "localeId" + ], "properties": { - "mobile": { - "type": "boolean" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "desktop": { - "type": "boolean" + "value": { + "type": "string" }, - "tablet": { - "type": "boolean" + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "type": "object" + } + ] + }, + "AppAdministrationSnippet": { + "description": "Added since version: 6.4.15.0", + "required": [ + "id", + "value", + "appId", + "localeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "value": { + "type": "string" }, - "versionId": { + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { + "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8875,27 +12511,12 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "translated": { - "type": "object" - }, - "page": { - "$ref": "#/components/schemas/CmsPage" - }, - "backgroundMedia": { - "$ref": "#/components/schemas/Media" - }, - "blocks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsBlock" - } } }, "type": "object" }, - "CmsSlotJsonApi": { - "description": "Added since version: 6.0.0.0", + "AppCmsBlockJsonApi": { + "description": "Added since version: 6.4.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -8903,47 +12524,34 @@ { "required": [ "id", - "type", - "slot", - "blockId", - "createdAt" + "name", + "block", + "template", + "styles", + "appId", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "type": "string" - }, - "slot": { + "name": { "type": "string" }, - "locked": { - "type": "boolean" - }, - "config": { - "type": "object" - }, - "customFields": { + "block": { "type": "object" }, - "data": { - "type": "object", - "readOnly": true + "template": { + "type": "string" }, - "blockId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "styles": { + "type": "string" }, - "fieldConfig": { - "type": "object" + "label": { + "type": "string" }, - "cmsBlockVersionId": { + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8962,7 +12570,7 @@ }, "relationships": { "properties": { - "block": { + "app": { "properties": { "links": { "type": "object", @@ -8970,7 +12578,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/block" + "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" } } }, @@ -8979,12 +12587,12 @@ "properties": { "type": { "type": "string", - "example": "cms_block" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "14511f2f5564650d129ca7cabc333278" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } @@ -8999,51 +12607,38 @@ } ] }, - "CmsSlot": { - "description": "Added since version: 6.0.0.0", + "AppCmsBlock": { + "description": "Added since version: 6.4.2.0", "required": [ "id", - "type", - "slot", - "blockId", - "createdAt" + "name", + "block", + "template", + "styles", + "appId", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "type": "string" - }, - "slot": { + "name": { "type": "string" }, - "locked": { - "type": "boolean" - }, - "config": { - "type": "object" - }, - "customFields": { + "block": { "type": "object" }, - "data": { - "type": "object", - "readOnly": true + "template": { + "type": "string" }, - "blockId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "styles": { + "type": "string" }, - "fieldConfig": { - "type": "object" + "label": { + "type": "string" }, - "cmsBlockVersionId": { + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9060,14 +12655,14 @@ "translated": { "type": "object" }, - "block": { - "$ref": "#/components/schemas/CmsBlock" + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "CountryJsonApi": { - "description": "Added since version: 6.0.0.0", + "AppFlowActionJsonApi": { + "description": "Added since version: 6.4.10.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -9075,110 +12670,70 @@ { "required": [ "id", - "createdAt", + "appId", "name", - "addressFormat" + "url", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "iso": { + "name": { "type": "string" }, - "position": { - "type": "integer", - "format": "int64" - }, - "active": { - "type": "boolean" - }, - "shippingAvailable": { - "type": "boolean" - }, - "iso3": { + "badge": { "type": "string" }, - "displayStateInRegistration": { - "type": "boolean" + "parameters": { + "type": "object" }, - "forceStateInRegistration": { - "type": "boolean" + "config": { + "type": "object" }, - "checkVatIdPattern": { - "type": "boolean" + "headers": { + "type": "object" }, - "vatIdRequired": { - "type": "boolean" + "requirements": { + "type": "array", + "items": { + "type": "string" + } }, - "vatIdPattern": { + "iconRaw": { "type": "string" }, - "customFields": { - "type": "object" + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true }, - "customerTax": { - "required": [ - "enabled", - "currencyId", - "amount" - ], - "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" - }, - "amount": { - "type": "number", - "format": "float" - } - }, - "type": "object" + "swIcon": { + "type": "string" }, - "companyTax": { - "required": [ - "enabled", - "currencyId", - "amount" - ], - "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" - }, - "amount": { - "type": "number", - "format": "float" - } - }, - "type": "object" + "url": { + "type": "string" }, - "postalCodeRequired": { + "delayable": { "type": "boolean" }, - "checkPostalCodePattern": { - "type": "boolean" + "label": { + "type": "string" }, - "checkAdvancedPostalCodePattern": { - "type": "boolean" + "description": { + "type": "string" }, - "advancedPostalCodePattern": { + "headline": { "type": "string" }, - "addressFormat": { + "customFields": { "type": "object" }, - "defaultPostalCodePattern": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -9194,100 +12749,7 @@ }, "relationships": { "properties": { - "states": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/states" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country_state" - }, - "id": { - "type": "string", - "example": "34d955a0df5f7af9c9b4e4dccb3c3564" - } - } - } - } - }, - "type": "object" - }, - "customerAddresses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/customerAddresses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "example": "84ed5cbc10cd9f665a8c9f05e49095af" - } - } - } - } - }, - "type": "object" - }, - "orderAddresses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/orderAddresses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_address" - }, - "id": { - "type": "string", - "example": "c3182f0dc0cc20b4982616d3e0221747" - } - } - } - } - }, - "type": "object" - }, - "salesChannelDefaultAssignments": { + "app": { "properties": { "links": { "type": "object", @@ -9295,92 +12757,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannelDefaultAssignments" + "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" - } - } - } - } - }, - "type": "object" - }, - "salesChannels": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannels" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" - } - } - } - } - }, - "type": "object" - }, - "taxRules": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { + "example": "app" + }, + "id": { "type": "string", - "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/taxRules" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tax_rule" - }, - "id": { - "type": "string", - "example": "1b93ada511aac379c19d3afcba4e4041" - } + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "currencyCountryRoundings": { + "flowSequences": { "properties": { "links": { "type": "object", @@ -9388,7 +12786,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/currencyCountryRoundings" + "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" } } }, @@ -9399,11 +12797,11 @@ "properties": { "type": { "type": "string", - "example": "currency_country_rounding" + "example": "flow_sequence" }, "id": { "type": "string", - "example": "35ef8dd5459bf5f08d44cb278bf07cd4" + "example": "3a0d70b6dd3624074e5e15cd07e7fa90" } } } @@ -9419,114 +12817,74 @@ } ] }, - "Country": { - "description": "Added since version: 6.0.0.0", + "AppFlowAction": { + "description": "Added since version: 6.4.10.0", "required": [ "id", - "createdAt", + "appId", "name", - "addressFormat" + "url", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "iso": { + "name": { "type": "string" }, - "position": { - "type": "integer", - "format": "int64" - }, - "active": { - "type": "boolean" - }, - "shippingAvailable": { - "type": "boolean" - }, - "iso3": { + "badge": { "type": "string" }, - "displayStateInRegistration": { - "type": "boolean" + "parameters": { + "type": "object" }, - "forceStateInRegistration": { - "type": "boolean" + "config": { + "type": "object" }, - "checkVatIdPattern": { - "type": "boolean" + "headers": { + "type": "object" }, - "vatIdRequired": { - "type": "boolean" + "requirements": { + "type": "array", + "items": { + "type": "string" + } }, - "vatIdPattern": { + "iconRaw": { "type": "string" }, - "customFields": { - "type": "object" + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true }, - "customerTax": { - "required": [ - "enabled", - "currencyId", - "amount" - ], - "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" - }, - "amount": { - "type": "number", - "format": "float" - } - }, - "type": "object" + "swIcon": { + "type": "string" }, - "companyTax": { - "required": [ - "enabled", - "currencyId", - "amount" - ], - "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" - }, - "amount": { - "type": "number", - "format": "float" - } - }, - "type": "object" + "url": { + "type": "string" }, - "postalCodeRequired": { + "delayable": { "type": "boolean" }, - "checkPostalCodePattern": { - "type": "boolean" + "label": { + "type": "string" }, - "checkAdvancedPostalCodePattern": { - "type": "boolean" + "description": { + "type": "string" }, - "advancedPostalCodePattern": { + "headline": { "type": "string" }, - "addressFormat": { + "customFields": { "type": "object" }, - "defaultPostalCodePattern": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -9540,53 +12898,20 @@ "translated": { "type": "object" }, - "states": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CountryState" - } - }, - "customerAddresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } - }, - "orderAddresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } - }, - "salesChannelDefaultAssignments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "salesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "taxRules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxRule" - } + "app": { + "$ref": "#/components/schemas/App" }, - "currencyCountryRoundings": { + "flowSequences": { "type": "array", "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/FlowSequence" } } }, "type": "object" }, - "CountryStateJsonApi": { - "description": "Added since version: 6.0.0.0", + "AppFlowEventJsonApi": { + "description": "Added since version: 6.5.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -9594,32 +12919,27 @@ { "required": [ "id", - "countryId", - "shortCode", - "createdAt", - "name" + "appId", + "name", + "aware" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shortCode": { - "type": "string" - }, "name": { "type": "string" }, - "position": { - "type": "integer", - "format": "int64" - }, - "active": { - "type": "boolean" + "aware": { + "type": "array", + "items": { + "type": "string" + } }, "customFields": { "type": "object" @@ -9634,12 +12954,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "country": { + "app": { "properties": { "links": { "type": "object", @@ -9647,7 +12964,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/country" + "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" } } }, @@ -9656,50 +12973,19 @@ "properties": { "type": { "type": "string", - "example": "country" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" - } - } - } - }, - "type": "object" - }, - "customerAddresses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/customerAddresses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "example": "84ed5cbc10cd9f665a8c9f05e49095af" - } + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "orderAddresses": { + "flows": { "properties": { "links": { "type": "object", @@ -9707,7 +12993,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/orderAddresses" + "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" } } }, @@ -9718,11 +13004,11 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "flow" }, "id": { "type": "string", - "example": "c3182f0dc0cc20b4982616d3e0221747" + "example": "0db2dd944f9ee9a131f44b79d331d371" } } } @@ -9738,36 +13024,31 @@ } ] }, - "CountryState": { - "description": "Added since version: 6.0.0.0", + "AppFlowEvent": { + "description": "Added since version: 6.5.2.0", "required": [ "id", - "countryId", - "shortCode", - "createdAt", - "name" + "appId", + "name", + "aware" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shortCode": { - "type": "string" - }, "name": { "type": "string" }, - "position": { - "type": "integer", - "format": "int64" - }, - "active": { - "type": "boolean" + "aware": { + "type": "array", + "items": { + "type": "string" + } }, "customFields": { "type": "object" @@ -9782,29 +13063,20 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "customerAddresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } + "app": { + "$ref": "#/components/schemas/App" }, - "orderAddresses": { + "flows": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/Flow" } } }, "type": "object" }, - "CurrencyJsonApi": { - "description": "Added since version: 6.0.0.0", + "AppPaymentMethodJsonApi": { + "description": "Added since version: 6.4.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -9812,92 +13084,50 @@ { "required": [ "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "createdAt", - "shortName", - "name" + "appName", + "identifier", + "paymentMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "factor": { - "type": "number", - "format": "float" + "appName": { + "type": "string" }, - "symbol": { + "identifier": { "type": "string" }, - "isoCode": { + "payUrl": { "type": "string" }, - "shortName": { + "finalizeUrl": { "type": "string" }, - "name": { + "validateUrl": { "type": "string" }, - "position": { - "type": "integer", - "format": "int64" + "captureUrl": { + "type": "string" }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" + "refundUrl": { + "type": "string" }, - "taxFreeFrom": { - "type": "number", - "format": "float" + "recurringUrl": { + "type": "string" }, - "customFields": { - "type": "object" + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "originalMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -9909,105 +13139,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "salesChannelDefaultAssignments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDefaultAssignments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" - } - } - } - } - }, - "type": "object" - }, - "orders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/orders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order" - }, - "id": { - "type": "string", - "example": "12c500ed0b7879105fb46af0f246be87" - } - } - } - } - }, - "type": "object" - }, - "salesChannels": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannels" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" - } - } - } - } - }, - "type": "object" - }, - "salesChannelDomains": { + "app": { "properties": { "links": { "type": "object", @@ -10015,61 +13149,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDomains" + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/app" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel_domain" - }, - "id": { - "type": "string", - "example": "b60ab8d110194bfe34ef9928ba48ab6d" - } - } - } - } - }, - "type": "object" - }, - "promotionDiscountPrices": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/promotionDiscountPrices" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "promotion_discount_prices" - }, - "id": { - "type": "string", - "example": "325723473ecab76b0f45e1554513f779" - } + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "productExports": { + "originalMedia": { "properties": { "links": { "type": "object", @@ -10077,30 +13178,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/productExports" + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/originalMedia" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_export" - }, - "id": { - "type": "string", - "example": "2cd8793787cda582174c0fc329fbc377" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "56386c66f82d9cd5639a5a7447971ead" } } } }, "type": "object" }, - "countryRoundings": { + "paymentMethod": { "properties": { "links": { "type": "object", @@ -10108,23 +13207,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/countryRoundings" + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/paymentMethod" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "currency_country_rounding" - }, - "id": { - "type": "string", - "example": "3de4aa80c8c8822ea10d156a6f58d6f7" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } @@ -10139,96 +13236,54 @@ } ] }, - "Currency": { - "description": "Added since version: 6.0.0.0", + "AppPaymentMethod": { + "description": "Added since version: 6.4.1.0", "required": [ "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "createdAt", - "shortName", - "name" + "appName", + "identifier", + "paymentMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "factor": { - "type": "number", - "format": "float" + "appName": { + "type": "string" }, - "symbol": { + "identifier": { "type": "string" }, - "isoCode": { + "payUrl": { "type": "string" }, - "shortName": { + "finalizeUrl": { "type": "string" }, - "name": { + "validateUrl": { "type": "string" }, - "position": { - "type": "integer", - "format": "int64" + "captureUrl": { + "type": "string" }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" + "refundUrl": { + "type": "string" }, - "taxFreeFrom": { - "type": "number", - "format": "float" + "recurringUrl": { + "type": "string" }, - "customFields": { - "type": "object" + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "originalMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -10240,56 +13295,20 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "salesChannelDefaultAssignments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "orders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } - }, - "salesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "salesChannelDomains": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelDomain" - } - }, - "promotionDiscountPrices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - } + "app": { + "$ref": "#/components/schemas/App" }, - "productExports": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductExport" - } + "originalMedia": { + "$ref": "#/components/schemas/Media" }, - "countryRoundings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" }, - "CurrencyCountryRoundingJsonApi": { - "description": "Added since version: 6.4.0.0", + "AppScriptConditionJsonApi": { + "description": "Added since version: 6.4.10.3", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -10297,67 +13316,38 @@ { "required": [ "id", - "currencyId", - "countryId", - "itemRounding", - "totalRounding", - "createdAt" + "identifier", + "active", + "appId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "identifier": { + "type": "string" }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "active": { + "type": "boolean" }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, + "group": { + "type": "string" + }, + "script": { + "type": "string" + }, + "config": { "type": "object" }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -10368,9 +13358,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "currency": { + "app": { "properties": { "links": { "type": "object", @@ -10378,7 +13371,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/currency" + "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" } } }, @@ -10387,19 +13380,19 @@ "properties": { "type": { "type": "string", - "example": "currency" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "country": { + "ruleConditions": { "properties": { "links": { "type": "object", @@ -10407,21 +13400,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/country" + "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/ruleConditions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule_condition" + }, + "id": { + "type": "string", + "example": "24bfabce4195894c9aed9b8bcfb0b748" + } } } } @@ -10436,71 +13431,42 @@ } ] }, - "CurrencyCountryRounding": { - "description": "Added since version: 6.4.0.0", + "AppScriptCondition": { + "description": "Added since version: 6.4.10.3", "required": [ "id", - "currencyId", - "countryId", - "itemRounding", - "totalRounding", - "createdAt" + "identifier", + "active", + "appId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "identifier": { + "type": "string" }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "active": { + "type": "boolean" }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, + "group": { + "type": "string" + }, + "script": { + "type": "string" + }, + "config": { "type": "object" }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -10511,17 +13477,23 @@ "format": "date-time", "readOnly": true }, - "currency": { - "$ref": "#/components/schemas/Currency" + "translated": { + "type": "object" }, - "country": { - "$ref": "#/components/schemas/Country" + "app": { + "$ref": "#/components/schemas/App" + }, + "ruleConditions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } } }, "type": "object" }, - "CustomEntityJsonApi": { - "description": "Added since version: 6.4.9.0", + "AppShippingMethodJsonApi": { + "description": "Added since version: 6.5.7.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -10529,49 +13501,32 @@ { "required": [ "id", - "name", - "fields", - "createdAt" + "appName", + "identifier", + "shippingMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "appName": { "type": "string" }, - "fields": { - "type": "object" - }, - "flags": { - "type": "object" + "identifier": { + "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "pluginId": { + "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsAware": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "storeApiAware": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "customFieldsAware": { - "type": "boolean" - }, - "labelProperty": { - "type": "string" - }, - "deletedAt": { + "originalMediaId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -10582,59 +13537,134 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + }, + "shippingMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/shippingMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + } + } + } + }, + "type": "object" + }, + "originalMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/originalMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "56386c66f82d9cd5639a5a7447971ead" + } + } + } + }, + "type": "object" + } + }, + "type": "object" } }, "type": "object" } ] }, - "CustomEntity": { - "description": "Added since version: 6.4.9.0", + "AppShippingMethod": { + "description": "Added since version: 6.5.7.0", "required": [ "id", - "name", - "fields", - "createdAt" + "appName", + "identifier", + "shippingMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "appName": { "type": "string" }, - "fields": { - "type": "object" - }, - "flags": { - "type": "object" + "identifier": { + "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "pluginId": { + "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsAware": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "storeApiAware": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "customFieldsAware": { - "type": "boolean" - }, - "labelProperty": { - "type": "string" - }, - "deletedAt": { + "originalMediaId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -10645,12 +13675,21 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "originalMedia": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "CustomFieldJsonApi": { - "description": "Added since version: 6.0.0.0", + "AppTemplateJsonApi": { + "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -10658,36 +13697,31 @@ { "required": [ "id", - "name", - "type", - "createdAt" + "template", + "path", + "active", + "appId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "template": { "type": "string" }, - "type": { + "path": { "type": "string" }, - "config": { - "type": "object" - }, "active": { "type": "boolean" }, - "customFieldSetId": { + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "allowCustomerWrite": { - "type": "boolean" - }, - "allowCartExpose": { - "type": "boolean" + "hash": { + "type": "string" }, "createdAt": { "type": "string", @@ -10701,7 +13735,7 @@ }, "relationships": { "properties": { - "customFieldSet": { + "app": { "properties": { "links": { "type": "object", @@ -10709,7 +13743,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/customFieldSet" + "example": "/app-template/ca9106b8b82ff55b6fdce530ccb952a7/app" } } }, @@ -10718,43 +13752,12 @@ "properties": { "type": { "type": "string", - "example": "custom_field_set" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "df17e58b74fa5cb09c5e84f3b37141e1" - } - } - } - }, - "type": "object" - }, - "productSearchConfigFields": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/productSearchConfigFields" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_search_config_field" - }, - "id": { - "type": "string", - "example": "ae6a70432f71d6905502769f184399b1" - } + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } @@ -10769,40 +13772,35 @@ } ] }, - "CustomField": { - "description": "Added since version: 6.0.0.0", + "AppTemplate": { + "description": "Added since version: 6.3.1.0", "required": [ "id", - "name", - "type", - "createdAt" + "template", + "path", + "active", + "appId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "template": { "type": "string" }, - "type": { + "path": { "type": "string" }, - "config": { - "type": "object" - }, "active": { "type": "boolean" }, - "customFieldSetId": { + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "allowCustomerWrite": { - "type": "boolean" - }, - "allowCartExpose": { - "type": "boolean" + "hash": { + "type": "string" }, "createdAt": { "type": "string", @@ -10814,19 +13812,13 @@ "format": "date-time", "readOnly": true }, - "customFieldSet": { - "$ref": "#/components/schemas/CustomFieldSet" - }, - "productSearchConfigFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "CustomFieldSetJsonApi": { + "CategoryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -10835,31 +13827,135 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "displayNestedProducts": { + "type": "boolean" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "breadcrumb": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "readOnly": true + }, + "level": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "type": "string", + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "type": { "type": "string" }, - "config": { - "type": "object" + "productAssignmentType": { + "type": "string" + }, + "visible": { + "type": "boolean" }, "active": { "type": "boolean" }, - "global": { + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "position": { + "visibleChildCount": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "integer", "format": "int64" }, - "appId": { + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "linkType": { + "type": "string" + }, + "internalLink": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalLink": { + "type": "string" + }, + "linkNewTab": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "metaTitle": { + "type": "string" + }, + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customEntityTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -10873,9 +13969,252 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "customFields": { + "parent": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "children": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/children" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + }, + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + }, + "nestedProducts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/nestedProducts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "cf73cebf9ade7f94deba94ec71e66e43" + } + } + } + } + }, + "type": "object" + }, + "tags": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "cmsPage": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/cmsPage" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7b1460918b1abb93311108f3dc021c9b" + } + } + } + }, + "type": "object" + }, + "productStream": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/productStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "49561f6faa0badfce831a183d2ec7c2f" + } + } + } + }, + "type": "object" + }, + "navigationSalesChannels": { "properties": { "links": { "type": "object", @@ -10883,7 +14222,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/customFields" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/navigationSalesChannels" } } }, @@ -10894,11 +14233,11 @@ "properties": { "type": { "type": "string", - "example": "custom_field" + "example": "sales_channel" }, "id": { "type": "string", - "example": "4e252ff73243c27b4df9002e452fc6a7" + "example": "04db458d860e0a4b455ae14b384a5e8a" } } } @@ -10906,7 +14245,7 @@ }, "type": "object" }, - "relations": { + "footerSalesChannels": { "properties": { "links": { "type": "object", @@ -10914,7 +14253,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/relations" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/footerSalesChannels" } } }, @@ -10925,11 +14264,11 @@ "properties": { "type": { "type": "string", - "example": "custom_field_set_relation" + "example": "sales_channel" }, "id": { "type": "string", - "example": "06c5b10273a69992d8c6933e294909fa" + "example": "57944aba1f6dea7ca9dacf66776e1755" } } } @@ -10937,7 +14276,7 @@ }, "type": "object" }, - "products": { + "serviceSalesChannels": { "properties": { "links": { "type": "object", @@ -10945,7 +14284,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/products" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/serviceSalesChannels" } } }, @@ -10956,11 +14295,11 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "sales_channel" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "1a79932fadba3b20baf6369181e45602" } } } @@ -10968,7 +14307,7 @@ }, "type": "object" }, - "app": { + "mainCategories": { "properties": { "links": { "type": "object", @@ -10976,21 +14315,54 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/app" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/mainCategories" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "main_category" + }, + "id": { + "type": "string", + "example": "1fb731fc4139cbb575429e28846f0c39" + } + } + } + } + }, + "type": "object" + }, + "seoUrls": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/seoUrls" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "seo_url" + }, + "id": { + "type": "string", + "example": "5321b5a71127b8b98cdd4b068ad56c4c" + } } } } @@ -11005,35 +14377,139 @@ } ] }, - "CustomFieldSet": { + "Category": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "displayNestedProducts": { + "type": "boolean" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "breadcrumb": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "readOnly": true + }, + "level": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "type": "string", + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "type": { "type": "string" }, - "config": { - "type": "object" + "productAssignmentType": { + "type": "string" + }, + "visible": { + "type": "boolean" }, "active": { "type": "boolean" }, - "global": { + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "position": { + "visibleChildCount": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "integer", "format": "int64" }, - "appId": { + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "linkType": { + "type": "string" + }, + "internalLink": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalLink": { + "type": "string" + }, + "linkNewTab": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "metaTitle": { + "type": "string" + }, + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customEntityTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -11047,31 +14523,111 @@ "format": "date-time", "readOnly": true }, - "customFields": { + "translated": { + "type": "object" + }, + "parent": { + "$ref": "#/components/schemas/Category" + }, + "children": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/Category" } }, - "relations": { + "media": { + "$ref": "#/components/schemas/Media" + }, + "products": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/Product" } }, - "products": { + "nestedProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, - "app": { - "$ref": "#/components/schemas/App" + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + }, + "navigationSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "footerSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "serviceSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "mainCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + }, + "seoUrls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } } }, "type": "object" }, - "CustomFieldSetRelationJsonApi": { + "CategoryTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "categoryId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "category": { + "$ref": "#/components/schemas/Category" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "CmsBlockJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -11080,22 +14636,85 @@ { "required": [ "id", - "customFieldSetId", - "entityName", - "createdAt" + "position", + "type", + "sectionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFieldSetId": { + "position": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "sectionPosition": { + "type": "string" + }, + "marginTop": { + "type": "string" + }, + "marginBottom": { + "type": "string" + }, + "marginLeft": { + "type": "string" + }, + "marginRight": { + "type": "string" + }, + "backgroundColor": { + "type": "string" + }, + "backgroundMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityName": { + "backgroundMediaMode": { + "type": "string" + }, + "cssClass": { "type": "string" }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "sectionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -11108,7 +14727,7 @@ }, "relationships": { "properties": { - "customFieldSet": { + "section": { "properties": { "links": { "type": "object", @@ -11116,7 +14735,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set-relation/9686e510825802f328b6a861ccaa977e/customFieldSet" + "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/section" } } }, @@ -11125,12 +14744,72 @@ "properties": { "type": { "type": "string", - "example": "custom_field_set" + "example": "cms_section" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "df17e58b74fa5cb09c5e84f3b37141e1" + "example": "73d5342eba070f636ac3246f319bf77f" + } + } + } + }, + "type": "object" + }, + "backgroundMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/backgroundMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9f63714a30b4d0292695bd4d27235a0b" + } + } + } + }, + "type": "object" + }, + "slots": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/slots" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_slot" + }, + "id": { + "type": "string", + "example": "a8b72798beb911ae98c8c8907d45950a" + } } } } @@ -11145,26 +14824,89 @@ } ] }, - "CustomFieldSetRelation": { + "CmsBlock": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "customFieldSetId", - "entityName", - "createdAt" + "position", + "type", + "sectionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFieldSetId": { + "position": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "sectionPosition": { + "type": "string" + }, + "marginTop": { + "type": "string" + }, + "marginBottom": { + "type": "string" + }, + "marginLeft": { + "type": "string" + }, + "marginRight": { + "type": "string" + }, + "backgroundColor": { + "type": "string" + }, + "backgroundMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityName": { + "backgroundMediaMode": { + "type": "string" + }, + "cssClass": { "type": "string" }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "sectionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -11175,13 +14917,22 @@ "format": "date-time", "readOnly": true }, - "customFieldSet": { - "$ref": "#/components/schemas/CustomFieldSet" + "section": { + "$ref": "#/components/schemas/CmsSection" + }, + "backgroundMedia": { + "$ref": "#/components/schemas/Media" + }, + "slots": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } } }, "type": "object" }, - "CustomerJsonApi": { + "CmsPageJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -11190,174 +14941,46 @@ { "required": [ "id", - "groupId", - "defaultPaymentMethodId", - "salesChannelId", - "languageId", - "defaultBillingAddressId", - "defaultShippingAddressId", - "customerNumber", - "firstName", - "lastName", - "email", - "accountType", - "createdAt" + "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "groupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "lastPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultBillingAddressId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultShippingAddressId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "customerNumber": { - "type": "string" - }, - "salutationId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "company": { - "type": "string" - }, - "email": { - "type": "string" - }, - "title": { - "type": "string" - }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "affiliateCode": { - "type": "string" - }, - "campaignCode": { + "name": { "type": "string" }, - "active": { - "type": "boolean" - }, - "doubleOptInRegistration": { - "type": "boolean" - }, - "doubleOptInEmailSentDate": { - "type": "string", - "format": "date-time" - }, - "doubleOptInConfirmDate": { - "type": "string", - "format": "date-time" - }, - "hash": { + "type": { "type": "string" }, - "guest": { - "type": "boolean" - }, - "firstLogin": { - "type": "string", - "format": "date-time" - }, - "lastLogin": { - "type": "string", - "format": "date-time" - }, - "birthday": { + "entity": { "type": "string" }, - "lastOrderDate": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "orderCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "orderTotalAmount": { - "type": "number", - "format": "float", - "readOnly": true - }, - "reviewCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "customFields": { - "type": "object" - }, - "remoteAddress": { + "cssClass": { "type": "string" }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "config": { + "properties": { + "backgroundColor": { + "type": "string" + } }, - "readOnly": true - }, - "requestedGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "object" }, - "boundSalesChannelId": { + "previewMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "accountType": { - "type": "string" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "locked": { + "type": "boolean" }, "createdAt": { "type": "string", @@ -11369,9 +14992,12 @@ "format": "date-time", "readOnly": true }, - "extensions": { + "translated": { + "type": "object" + }, + "relationships": { "properties": { - "attendee": { + "sections": { "properties": { "links": { "type": "object", @@ -11379,7 +15005,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/attendee" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/sections" } } }, @@ -11390,53 +15016,19 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_appointment_attendee" + "example": "cms_section" }, "id": { "type": "string", - "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" + "example": "ff4dee88db82e98f0e0d524d965b9aa7" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "group": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/group" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_group" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "db0f6f37ebeb6ea09489124345af2a45" - } - } - } - }, - "type": "object" }, - "defaultPaymentMethod": { + "previewMedia": { "properties": { "links": { "type": "object", @@ -11444,7 +15036,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultPaymentMethod" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/previewMedia" } } }, @@ -11453,19 +15045,19 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8f35e31802b72bf010a333999b26f3a6" + "example": "a7a817fb0e422cff87e878b8ff7ca914" } } } }, "type": "object" }, - "salesChannel": { + "categories": { "properties": { "links": { "type": "object", @@ -11473,28 +15065,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannel" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/categories" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" + } } } } }, "type": "object" }, - "language": { + "landingPages": { "properties": { "links": { "type": "object", @@ -11502,28 +15096,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/language" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/landingPages" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "landing_page" + }, + "id": { + "type": "string", + "example": "d60b77f2b3bd69591e3d5e3100926b4d" + } } } } }, "type": "object" }, - "lastPaymentMethod": { + "homeSalesChannels": { "properties": { "links": { "type": "object", @@ -11531,28 +15127,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/lastPaymentMethod" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/homeSalesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "payment_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "bb083200005a374b86f6f5fbbff6f0e0" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "9aed0c38161f67f2d40a4a872cae045f" + } } } } }, "type": "object" }, - "defaultBillingAddress": { + "products": { "properties": { "links": { "type": "object", @@ -11560,28 +15158,223 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultBillingAddress" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/products" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "263d0f6e5d8d71fc4c288736f7c90990" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CmsPage": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "entity": { + "type": "string" + }, + "cssClass": { + "type": "string" + }, + "config": { + "properties": { + "backgroundColor": { + "type": "string" + } + }, + "type": "object" + }, + "previewMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "locked": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "sections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + }, + "previewMedia": { + "$ref": "#/components/schemas/Media" + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "landingPages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + }, + "homeSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + }, + "type": "object" + }, + "CmsSectionJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "position", + "type", + "pageId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "sizingMode": { + "type": "string" + }, + "mobileBehavior": { + "type": "string" + }, + "backgroundColor": { + "type": "string" + }, + "backgroundMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "type": "string" + }, + "cssClass": { + "type": "string" + }, + "pageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" }, - "defaultShippingAddress": { + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "page": { "properties": { "links": { "type": "object", @@ -11589,7 +15382,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultShippingAddress" + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/page" } } }, @@ -11598,19 +15391,19 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8218c377171d06883caea7e2baf67f31" + "example": "71860c77c6745379b0d44304d66b6a13" } } } }, "type": "object" }, - "salutation": { + "backgroundMedia": { "properties": { "links": { "type": "object", @@ -11618,7 +15411,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salutation" + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/backgroundMedia" } } }, @@ -11627,19 +15420,19 @@ "properties": { "type": { "type": "string", - "example": "salutation" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "example": "9f63714a30b4d0292695bd4d27235a0b" } } } }, "type": "object" }, - "addresses": { + "blocks": { "properties": { "links": { "type": "object", @@ -11647,7 +15440,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/addresses" + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/blocks" } } }, @@ -11658,19 +15451,193 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "cms_block" }, "id": { "type": "string", - "example": "963e3a2fe559e393bad631f3dc686f69" + "example": "e734964953f880e5164e32827950ff92" } } } } }, "type": "object" - }, - "orderCustomers": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CmsSection": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "position", + "type", + "pageId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "sizingMode": { + "type": "string" + }, + "mobileBehavior": { + "type": "string" + }, + "backgroundColor": { + "type": "string" + }, + "backgroundMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "type": "string" + }, + "cssClass": { + "type": "string" + }, + "pageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "page": { + "$ref": "#/components/schemas/CmsPage" + }, + "backgroundMedia": { + "$ref": "#/components/schemas/Media" + }, + "blocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + } + }, + "type": "object" + }, + "CmsSlotJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "type", + "slot", + "blockId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "slot": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "config": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "data": { + "type": "object", + "readOnly": true + }, + "blockId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "block": { "properties": { "links": { "type": "object", @@ -11678,92 +15645,232 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/orderCustomers" + "example": "/cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/block" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_customer" - }, - "id": { - "type": "string", - "example": "1e7dbe7e3bcb48d233fd80588f54c980" - } - } - } - } - }, - "type": "object" - }, - "tags": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/tags" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tag" - }, - "id": { - "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" - } - } - } - } - }, - "type": "object" - }, - "promotions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { + "example": "cms_block" + }, + "id": { "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/promotions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "promotion" - }, - "id": { - "type": "string", - "example": "ea6aeb050f871384f25fba9c869cfe21" - } + "pattern": "^[0-9a-f]{32}$", + "example": "14511f2f5564650d129ca7cabc333278" } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CmsSlot": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "type", + "slot", + "blockId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "slot": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "config": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "data": { + "type": "object", + "readOnly": true + }, + "blockId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "block": { + "$ref": "#/components/schemas/CmsBlock" + } + }, + "type": "object" + }, + "CountryJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "addressFormat" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "iso": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "shippingAvailable": { + "type": "boolean" + }, + "iso3": { + "type": "string" + }, + "displayStateInRegistration": { + "type": "boolean" + }, + "forceStateInRegistration": { + "type": "boolean" + }, + "checkVatIdPattern": { + "type": "boolean" + }, + "vatIdRequired": { + "type": "boolean" + }, + "vatIdPattern": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" }, - "productReviews": { + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "companyTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "postalCodeRequired": { + "type": "boolean" + }, + "checkPostalCodePattern": { + "type": "boolean" + }, + "checkAdvancedPostalCodePattern": { + "type": "boolean" + }, + "advancedPostalCodePattern": { + "type": "string" + }, + "addressFormat": { + "type": "object" + }, + "defaultPostalCodePattern": { + "type": "string" + }, + "isEu": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "states": { "properties": { "links": { "type": "object", @@ -11771,7 +15878,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/productReviews" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/states" } } }, @@ -11782,11 +15889,11 @@ "properties": { "type": { "type": "string", - "example": "product_review" + "example": "country_state" }, "id": { "type": "string", - "example": "01e78541ea343ed72424a5222796a4cd" + "example": "34d955a0df5f7af9c9b4e4dccb3c3564" } } } @@ -11794,7 +15901,7 @@ }, "type": "object" }, - "recoveryCustomer": { + "customerAddresses": { "properties": { "links": { "type": "object", @@ -11802,28 +15909,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/recoveryCustomer" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/customerAddresses" } } }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_recovery" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ce9d8d13e51bf43bc70a4be38950823b" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "example": "84ed5cbc10cd9f665a8c9f05e49095af" + } } } } }, "type": "object" }, - "requestedGroup": { + "orderAddresses": { "properties": { "links": { "type": "object", @@ -11831,28 +15940,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/requestedGroup" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/orderAddresses" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_group" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "46cf25a3f20102ff5e1e17526fb73b62" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "example": "c3182f0dc0cc20b4982616d3e0221747" + } } } } }, "type": "object" }, - "boundSalesChannel": { + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -11860,28 +15971,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/boundSalesChannel" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannelDefaultAssignments" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "dfe8aec35136b1f62669b388a291a4c7" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "b23663b2abc0909be9a8027a3fbff74b" + } } } } }, "type": "object" }, - "wishlists": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -11889,7 +16002,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/wishlists" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannels" } } }, @@ -11900,11 +16013,11 @@ "properties": { "type": { "type": "string", - "example": "customer_wishlist" + "example": "sales_channel" }, "id": { "type": "string", - "example": "4ec38c6b2208529c1fadccc7d55d7947" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -11912,7 +16025,7 @@ }, "type": "object" }, - "createdBy": { + "taxRules": { "properties": { "links": { "type": "object", @@ -11920,28 +16033,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/createdBy" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/taxRules" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_rule" + }, + "id": { + "type": "string", + "example": "1b93ada511aac379c19d3afcba4e4041" + } } } } }, "type": "object" }, - "updatedBy": { + "currencyCountryRoundings": { "properties": { "links": { "type": "object", @@ -11949,21 +16064,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/updatedBy" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/currencyCountryRoundings" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency_country_rounding" + }, + "id": { + "type": "string", + "example": "35ef8dd5459bf5f08d44cb278bf07cd4" + } } } } @@ -11978,178 +16095,115 @@ } ] }, - "Customer": { + "Country": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "groupId", - "defaultPaymentMethodId", - "salesChannelId", - "languageId", - "defaultBillingAddressId", - "defaultShippingAddressId", - "customerNumber", - "firstName", - "lastName", - "email", - "accountType", - "createdAt" + "name", + "addressFormat" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "groupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "lastPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultBillingAddressId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultShippingAddressId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "customerNumber": { - "type": "string" - }, - "salutationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "company": { - "type": "string" - }, - "email": { - "type": "string" - }, - "title": { + "name": { "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "affiliateCode": { + "iso": { "type": "string" }, - "campaignCode": { - "type": "string" + "position": { + "type": "integer", + "format": "int64" }, "active": { "type": "boolean" }, - "doubleOptInRegistration": { + "shippingAvailable": { "type": "boolean" }, - "doubleOptInEmailSentDate": { - "type": "string", - "format": "date-time" - }, - "doubleOptInConfirmDate": { - "type": "string", - "format": "date-time" - }, - "hash": { + "iso3": { "type": "string" }, - "guest": { + "displayStateInRegistration": { "type": "boolean" }, - "firstLogin": { - "type": "string", - "format": "date-time" - }, - "lastLogin": { - "type": "string", - "format": "date-time" - }, - "birthday": { - "type": "string" - }, - "lastOrderDate": { - "type": "string", - "format": "date-time", - "readOnly": true + "forceStateInRegistration": { + "type": "boolean" }, - "orderCount": { - "type": "integer", - "format": "int64", - "readOnly": true + "checkVatIdPattern": { + "type": "boolean" }, - "orderTotalAmount": { - "type": "number", - "format": "float", - "readOnly": true + "vatIdRequired": { + "type": "boolean" }, - "reviewCount": { - "type": "integer", - "format": "int64", - "readOnly": true + "vatIdPattern": { + "type": "string" }, "customFields": { "type": "object" }, - "remoteAddress": { - "type": "string" + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "companyTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } }, - "readOnly": true + "type": "object" }, - "requestedGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "postalCodeRequired": { + "type": "boolean" }, - "boundSalesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "checkPostalCodePattern": { + "type": "boolean" + }, + "checkAdvancedPostalCodePattern": { + "type": "boolean" }, - "accountType": { + "advancedPostalCodePattern": { "type": "string" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "addressFormat": { + "type": "object" }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "defaultPostalCodePattern": { + "type": "string" + }, + "isEu": { + "type": "boolean" }, "createdAt": { "type": "string", @@ -12161,121 +16215,55 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "attendee": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/attendee" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment_attendee" - }, - "id": { - "type": "string", - "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" - } - } - } - } - }, - "type": "object" - } - }, + "translated": { "type": "object" }, - "group": { - "$ref": "#/components/schemas/CustomerGroup" - }, - "defaultPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - }, - "language": { - "$ref": "#/components/schemas/Language" - }, - "lastPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - }, - "defaultBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress" - }, - "defaultShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "states": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } }, - "addresses": { + "customerAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" } }, - "orderCustomers": { + "orderAddresses": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderAddress" } }, - "tags": { + "salesChannelDefaultAssignments": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SalesChannel" } }, - "promotions": { + "salesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/SalesChannel" } }, - "productReviews": { + "taxRules": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/TaxRule" } }, - "recoveryCustomer": { - "$ref": "#/components/schemas/CustomerRecovery" - }, - "requestedGroup": { - "$ref": "#/components/schemas/CustomerGroup" - }, - "boundSalesChannel": { - "$ref": "#/components/schemas/SalesChannel" - }, - "wishlists": { + "currencyCountryRoundings": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CurrencyCountryRounding" } - }, - "createdBy": { - "$ref": "#/components/schemas/User" - }, - "updatedBy": { - "$ref": "#/components/schemas/User" } }, "type": "object" }, - "CustomerAddressJsonApi": { + "CountryStateJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -12284,67 +16272,31 @@ { "required": [ "id", - "customerId", "countryId", - "firstName", - "lastName", - "city", - "street", - "createdAt" + "shortCode", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "zipcode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "company": { - "type": "string" - }, - "street": { - "type": "string" - }, - "department": { - "type": "string" - }, - "title": { + "shortCode": { "type": "string" }, - "phoneNumber": { + "name": { "type": "string" }, - "additionalAddressLine1": { - "type": "string" + "position": { + "type": "integer", + "format": "int64" }, - "additionalAddressLine2": { - "type": "string" + "active": { + "type": "boolean" }, "customFields": { "type": "object" @@ -12354,42 +16306,16 @@ "format": "date-time", "readOnly": true }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "customer": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/customer" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" - } - } - } - }, - "type": "object" - }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { "country": { "properties": { "links": { @@ -12398,7 +16324,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/country" } } }, @@ -12419,7 +16345,7 @@ }, "type": "object" }, - "countryState": { + "customerAddresses": { "properties": { "links": { "type": "object", @@ -12427,28 +16353,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/customerAddresses" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country_state" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "cb6a9764567191fb74fe28d8d6a4819d" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "example": "84ed5cbc10cd9f665a8c9f05e49095af" + } } } } }, "type": "object" }, - "salutation": { + "orderAddresses": { "properties": { "links": { "type": "object", @@ -12456,21 +16384,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/orderAddresses" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "salutation" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "example": "c3182f0dc0cc20b4982616d3e0221747" + } } } } @@ -12485,71 +16415,35 @@ } ] }, - "CustomerAddress": { + "CountryState": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "customerId", "countryId", - "firstName", - "lastName", - "city", - "street", - "createdAt" + "shortCode", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salutationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "zipcode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "company": { - "type": "string" - }, - "street": { - "type": "string" - }, - "department": { - "type": "string" - }, - "title": { + "shortCode": { "type": "string" }, - "phoneNumber": { + "name": { "type": "string" }, - "additionalAddressLine1": { - "type": "string" + "position": { + "type": "integer", + "format": "int64" }, - "additionalAddressLine2": { - "type": "string" + "active": { + "type": "boolean" }, "customFields": { "type": "object" @@ -12564,22 +16458,28 @@ "format": "date-time", "readOnly": true }, - "customer": { - "$ref": "#/components/schemas/Customer" + "translated": { + "type": "object" }, "country": { "$ref": "#/components/schemas/Country" }, - "countryState": { - "$ref": "#/components/schemas/CountryState" + "customerAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "orderAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } } }, "type": "object" }, - "CustomerGroupJsonApi": { + "CurrencyJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -12588,7 +16488,12 @@ { "required": [ "id", - "createdAt", + "factor", + "symbol", + "isoCode", + "itemRounding", + "totalRounding", + "shortName", "name" ], "properties": { @@ -12596,29 +16501,78 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "displayGross": { - "type": "boolean" + "factor": { + "type": "number", + "format": "float" }, - "customFields": { - "type": "object" + "symbol": { + "type": "string" }, - "registrationActive": { - "type": "boolean" + "isoCode": { + "type": "string" }, - "registrationTitle": { + "shortName": { "type": "string" }, - "registrationIntroduction": { + "name": { "type": "string" }, - "registrationOnlyCompanyRegistration": { + "position": { + "type": "integer", + "format": "int64" + }, + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "registrationSeoMetaDescription": { - "type": "string" + "taxFreeFrom": { + "type": "number", + "format": "float" + }, + "customFields": { + "type": "object" + }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" }, "createdAt": { "type": "string", @@ -12635,7 +16589,7 @@ }, "relationships": { "properties": { - "customers": { + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -12643,7 +16597,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customers" + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDefaultAssignments" } } }, @@ -12654,11 +16608,42 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "sales_channel" }, "id": { "type": "string", - "example": "4b6f7d34a58ba399f077685951d06738" + "example": "b23663b2abc0909be9a8027a3fbff74b" + } + } + } + } + }, + "type": "object" + }, + "orders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/orders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "example": "12c500ed0b7879105fb46af0f246be87" } } } @@ -12674,7 +16659,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/salesChannels" + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannels" } } }, @@ -12697,7 +16682,7 @@ }, "type": "object" }, - "registrationSalesChannels": { + "salesChannelDomains": { "properties": { "links": { "type": "object", @@ -12705,7 +16690,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/registrationSalesChannels" + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDomains" } } }, @@ -12716,11 +16701,104 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "sales_channel_domain" }, "id": { "type": "string", - "example": "ffc8e76c1fe257d563b9d0024a50620b" + "example": "b60ab8d110194bfe34ef9928ba48ab6d" + } + } + } + } + }, + "type": "object" + }, + "promotionDiscountPrices": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/promotionDiscountPrices" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion_discount_prices" + }, + "id": { + "type": "string", + "example": "325723473ecab76b0f45e1554513f779" + } + } + } + } + }, + "type": "object" + }, + "productExports": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/productExports" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_export" + }, + "id": { + "type": "string", + "example": "2cd8793787cda582174c0fc329fbc377" + } + } + } + } + }, + "type": "object" + }, + "countryRoundings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/countryRoundings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency_country_rounding" + }, + "id": { + "type": "string", + "example": "3de4aa80c8c8822ea10d156a6f58d6f7" } } } @@ -12736,11 +16814,16 @@ } ] }, - "CustomerGroup": { + "Currency": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", + "factor", + "symbol", + "isoCode", + "itemRounding", + "totalRounding", + "shortName", "name" ], "properties": { @@ -12748,29 +16831,78 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "displayGross": { - "type": "boolean" + "factor": { + "type": "number", + "format": "float" }, - "customFields": { - "type": "object" + "symbol": { + "type": "string" }, - "registrationActive": { - "type": "boolean" + "isoCode": { + "type": "string" }, - "registrationTitle": { + "shortName": { "type": "string" }, - "registrationIntroduction": { + "name": { "type": "string" }, - "registrationOnlyCompanyRegistration": { + "position": { + "type": "integer", + "format": "int64" + }, + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "registrationSeoMetaDescription": { - "type": "string" + "taxFreeFrom": { + "type": "number", + "format": "float" + }, + "customFields": { + "type": "object" + }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" }, "createdAt": { "type": "string", @@ -12785,63 +16917,53 @@ "translated": { "type": "object" }, - "customers": { + "salesChannelDefaultAssignments": { "type": "array", "items": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/SalesChannel" } }, - "salesChannels": { + "orders": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Order" } }, - "registrationSalesChannels": { + "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } - } - }, - "type": "object" - }, - "CustomerGroupRegistrationSalesChannels": { - "description": "Added since version: 6.3.1.0", - "required": [ - "customerGroupId", - "salesChannelId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "salesChannelDomains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "promotionDiscountPrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } }, - "customerGroup": { - "$ref": "#/components/schemas/CustomerGroup" + "productExports": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "countryRoundings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } } }, "type": "object" }, - "CustomerRecoveryJsonApi": { - "description": "Added since version: 6.1.0.0", + "CurrencyCountryRoundingJsonApi": { + "description": "Added since version: 6.4.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -12849,22 +16971,66 @@ { "required": [ "id", - "hash", - "customerId", - "createdAt" + "currencyId", + "countryId", + "itemRounding", + "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hash": { - "type": "string" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -12877,7 +17043,7 @@ }, "relationships": { "properties": { - "customer": { + "currency": { "properties": { "links": { "type": "object", @@ -12885,7 +17051,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-recovery/5c91cd3c845f51250c566f72e5fec3bf/customer" + "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/currency" } } }, @@ -12894,12 +17060,41 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "1af0389838508d7016a9841eb6273962" + } + } + } + }, + "type": "object" + }, + "country": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/country" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } @@ -12914,26 +17109,70 @@ } ] }, - "CustomerRecovery": { - "description": "Added since version: 6.1.0.0", + "CurrencyCountryRounding": { + "description": "Added since version: 6.4.0.0", "required": [ "id", - "hash", - "customerId", - "createdAt" + "currencyId", + "countryId", + "itemRounding", + "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hash": { - "type": "string" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -12944,42 +17183,144 @@ "format": "date-time", "readOnly": true }, - "customer": { - "$ref": "#/components/schemas/Customer" + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "country": { + "$ref": "#/components/schemas/Country" } }, "type": "object" }, - "CustomerTag": { - "description": "Added since version: 6.0.0.0", + "CustomEntityJsonApi": { + "description": "Added since version: 6.4.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "fields" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "fields": { + "type": "object" + }, + "flags": { + "type": "object" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pluginId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "storeApiAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "customFieldsAware": { + "type": "boolean" + }, + "labelProperty": { + "type": "string" + }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "CustomEntity": { + "description": "Added since version: 6.4.9.0", "required": [ - "customerId", - "tagId" + "id", + "name", + "fields" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "name": { + "type": "string" + }, + "fields": { + "type": "object" + }, + "flags": { + "type": "object" + }, + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "tagId": { + "pluginId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customer": { - "$ref": "#/components/schemas/Customer" + "cmsAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" }, - "tag": { - "$ref": "#/components/schemas/Tag" + "storeApiAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "customFieldsAware": { + "type": "boolean" + }, + "labelProperty": { + "type": "string" + }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "type": "object" }, - "CustomerWishlistJsonApi": { - "description": "Added since version: 6.3.4.0", + "CustomFieldJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -12987,25 +17328,38 @@ { "required": [ "id", - "customerId", - "salesChannelId", - "createdAt" + "name", + "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "salesChannelId": { + "type": { + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "type": "boolean" + }, + "customFieldSetId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "allowCustomerWrite": { + "type": "boolean" + }, + "allowCartExpose": { + "type": "boolean" + }, + "storeApiAware": { + "type": "boolean" }, "createdAt": { "type": "string", @@ -13019,38 +17373,7 @@ }, "relationships": { "properties": { - "products": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/products" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_wishlist_product" - }, - "id": { - "type": "string", - "example": "86024cad1e83101d97359d7351051156" - } - } - } - } - }, - "type": "object" - }, - "customer": { + "customFieldSet": { "properties": { "links": { "type": "object", @@ -13058,7 +17381,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/customer" + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/customFieldSet" } } }, @@ -13067,19 +17390,19 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "custom_field_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "df17e58b74fa5cb09c5e84f3b37141e1" } } } }, "type": "object" }, - "salesChannel": { + "productSearchConfigFields": { "properties": { "links": { "type": "object", @@ -13087,21 +17410,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/salesChannel" + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/productSearchConfigFields" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_config_field" + }, + "id": { + "type": "string", + "example": "ae6a70432f71d6905502769f184399b1" + } } } } @@ -13116,29 +17441,42 @@ } ] }, - "CustomerWishlist": { - "description": "Added since version: 6.3.4.0", + "CustomField": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "customerId", - "salesChannelId", - "createdAt" + "name", + "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "salesChannelId": { + "type": { + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "type": "boolean" + }, + "customFieldSetId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "allowCustomerWrite": { + "type": "boolean" + }, + "allowCartExpose": { + "type": "boolean" + }, + "storeApiAware": { + "type": "boolean" }, "createdAt": { "type": "string", @@ -13150,23 +17488,20 @@ "format": "date-time", "readOnly": true }, - "products": { + "customFieldSet": { + "$ref": "#/components/schemas/CustomFieldSet" + }, + "productSearchConfigFields": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/ProductSearchConfigField" } - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "CustomerWishlistProductJsonApi": { - "description": "Added since version: 6.3.4.0", + "CustomFieldSetJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -13174,24 +17509,30 @@ { "required": [ "id", - "productId", - "wishlistId", - "createdAt" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "config": { + "type": "object" }, - "wishlistId": { + "active": { + "type": "boolean" + }, + "global": { + "type": "boolean" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -13207,7 +17548,7 @@ }, "relationships": { "properties": { - "wishlist": { + "customFields": { "properties": { "links": { "type": "object", @@ -13215,28 +17556,92 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/wishlist" + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/customFields" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field" + }, + "id": { + "type": "string", + "example": "4e252ff73243c27b4df9002e452fc6a7" + } + } + } + } + }, + "type": "object" + }, + "relations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/relations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set_relation" + }, + "id": { + "type": "string", + "example": "06c5b10273a69992d8c6933e294909fa" + } + } + } + } + }, + "type": "object" + }, + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/products" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_wishlist" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "723edf7c24638ed18d2fa831e647a5cc" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } } } } }, "type": "object" }, - "product": { + "app": { "properties": { "links": { "type": "object", @@ -13244,7 +17649,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/product" + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/app" } } }, @@ -13253,12 +17658,12 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } @@ -13273,28 +17678,34 @@ } ] }, - "CustomerWishlistProduct": { - "description": "Added since version: 6.3.4.0", + "CustomFieldSet": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "productId", - "wishlistId", - "createdAt" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "config": { + "type": "object" }, - "wishlistId": { + "active": { + "type": "boolean" + }, + "global": { + "type": "boolean" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -13308,16 +17719,31 @@ "format": "date-time", "readOnly": true }, - "wishlist": { - "$ref": "#/components/schemas/CustomerWishlist" + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } }, - "product": { - "$ref": "#/components/schemas/Product" + "relations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "DeliveryTimeJsonApi": { + "CustomFieldSetRelationJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -13326,34 +17752,21 @@ { "required": [ "id", - "name", - "min", - "max", - "unit", - "createdAt" + "customFieldSetId", + "entityName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "min": { - "type": "integer", - "format": "int64" - }, - "max": { - "type": "integer", - "format": "int64" + "customFieldSetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "unit": { + "entityName": { "type": "string" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -13364,12 +17777,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "shippingMethods": { + "customFieldSet": { "properties": { "links": { "type": "object", @@ -13377,54 +17787,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/shippingMethods" + "example": "/custom-field-set-relation/9686e510825802f328b6a861ccaa977e/customFieldSet" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "shipping_method" - }, - "id": { - "type": "string", - "example": "8268b0a6c902fbde485094c2f627b854" - } - } - } - } - }, - "type": "object" - }, - "products": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/products" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "86024cad1e83101d97359d7351051156" - } + "example": "custom_field_set" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "df17e58b74fa5cb09c5e84f3b37141e1" } } } @@ -13439,38 +17816,25 @@ } ] }, - "DeliveryTime": { + "CustomFieldSetRelation": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "min", - "max", - "unit", - "createdAt" + "customFieldSetId", + "entityName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "min": { - "type": "integer", - "format": "int64" - }, - "max": { - "type": "integer", - "format": "int64" + "customFieldSetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "unit": { + "entityName": { "type": "string" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -13481,25 +17845,13 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "shippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethod" - } - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } + "customFieldSet": { + "$ref": "#/components/schemas/CustomFieldSet" } }, "type": "object" }, - "DocumentJsonApi": { + "CustomerJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -13508,59 +17860,161 @@ { "required": [ "id", - "documentTypeId", - "fileType", - "orderId", - "config", - "deepLinkCode", - "createdAt" + "groupId", + "salesChannelId", + "languageId", + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", + "firstName", + "lastName", + "email", + "defaultPaymentMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentTypeId": { + "groupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileType": { - "type": "string" + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "referencedDocumentId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { + "lastPaymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentMediaFileId": { + "defaultBillingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "defaultShippingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object" + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true }, - "sent": { + "customerNumber": { + "type": "string" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "email": { + "type": "string" + }, + "title": { + "type": "string" + }, + "affiliateCode": { + "type": "string" + }, + "campaignCode": { + "type": "string" + }, + "active": { "type": "boolean" }, - "static": { + "doubleOptInRegistration": { "type": "boolean" }, - "deepLinkCode": { + "doubleOptInEmailSentDate": { + "type": "string", + "format": "date-time" + }, + "doubleOptInConfirmDate": { + "type": "string", + "format": "date-time" + }, + "hash": { "type": "string" }, - "documentNumber": { + "guest": { + "type": "boolean" + }, + "firstLogin": { + "type": "string", + "format": "date-time" + }, + "lastLogin": { + "type": "string", + "format": "date-time" + }, + "birthday": { "type": "string" }, + "lastOrderDate": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "orderCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderTotalAmount": { + "type": "number", + "format": "float", + "readOnly": true + }, + "reviewCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, "customFields": { "type": "object" }, + "remoteAddress": { + "type": "string" + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "requestedGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "boundSalesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultPaymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -13573,7 +18027,181 @@ }, "relationships": { "properties": { - "documentType": { + "group": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/group" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "db0f6f37ebeb6ea09489124345af2a45" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "language": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" + } + } + } + }, + "type": "object" + }, + "lastPaymentMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/lastPaymentMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bb083200005a374b86f6f5fbbff6f0e0" + } + } + } + }, + "type": "object" + }, + "defaultBillingAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultBillingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "263d0f6e5d8d71fc4c288736f7c90990" + } + } + } + }, + "type": "object" + }, + "activeBillingAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeBillingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1a4362407b6a71fa80952dcd4ba7feb3" + } + } + } + }, + "type": "object" + }, + "defaultShippingAddress": { "properties": { "links": { "type": "object", @@ -13581,7 +18209,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentType" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultShippingAddress" } } }, @@ -13590,19 +18218,19 @@ "properties": { "type": { "type": "string", - "example": "document_type" + "example": "customer_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "2e45fec65781ec559e2aea39372a55cd" + "example": "8218c377171d06883caea7e2baf67f31" } } } }, "type": "object" }, - "order": { + "activeShippingAddress": { "properties": { "links": { "type": "object", @@ -13610,7 +18238,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document/0945359809dad1fbf3dea1c95a0da951/order" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeShippingAddress" } } }, @@ -13619,19 +18247,19 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "customer_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "f6e2f5dd29b543b8547e30d2d71a6974" } } } }, "type": "object" }, - "referencedDocument": { + "salutation": { "properties": { "links": { "type": "object", @@ -13639,7 +18267,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document/0945359809dad1fbf3dea1c95a0da951/referencedDocument" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salutation" } } }, @@ -13648,19 +18276,19 @@ "properties": { "type": { "type": "string", - "example": "document" + "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "75c3c346b0ef4f319e71925ce164a9ae" + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" }, - "dependentDocuments": { + "addresses": { "properties": { "links": { "type": "object", @@ -13668,7 +18296,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document/0945359809dad1fbf3dea1c95a0da951/dependentDocuments" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/addresses" } } }, @@ -13679,11 +18307,11 @@ "properties": { "type": { "type": "string", - "example": "document" + "example": "customer_address" }, "id": { "type": "string", - "example": "e74b269b7d5f269051463569677da2a0" + "example": "963e3a2fe559e393bad631f3dc686f69" } } } @@ -13691,7 +18319,7 @@ }, "type": "object" }, - "documentMediaFile": { + "orderCustomers": { "properties": { "links": { "type": "object", @@ -13699,184 +18327,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentMediaFile" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/orderCustomers" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ac7db1e6be481d6422fc63700e08279d" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_customer" + }, + "id": { + "type": "string", + "example": "1e7dbe7e3bcb48d233fd80588f54c980" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "Document": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "documentTypeId", - "fileType", - "orderId", - "config", - "deepLinkCode", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fileType": { - "type": "string" - }, - "referencedDocumentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentMediaFileId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "config": { - "type": "object" - }, - "sent": { - "type": "boolean" - }, - "static": { - "type": "boolean" - }, - "deepLinkCode": { - "type": "string" - }, - "documentNumber": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "documentType": { - "$ref": "#/components/schemas/DocumentType" - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "referencedDocument": { - "$ref": "#/components/schemas/Document" - }, - "dependentDocuments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } - }, - "documentMediaFile": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "DocumentBaseConfigJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "documentTypeId", - "name", - "global", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "logoId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "filenamePrefix": { - "type": "string" - }, - "filenameSuffix": { - "type": "string" - }, - "global": { - "type": "boolean" - }, - "documentNumber": { - "type": "string" - }, - "config": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "customFields": { - "type": "object" - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "documentType": { + }, + "tags": { "properties": { "links": { "type": "object", @@ -13884,28 +18358,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/documentType" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/tags" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "document_type" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2e45fec65781ec559e2aea39372a55cd" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } } } } }, "type": "object" }, - "logo": { + "promotions": { "properties": { "links": { "type": "object", @@ -13913,28 +18389,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/logo" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/promotions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "96d6f2e7e1f705ab5e59c84a6dc009b2" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "example": "ea6aeb050f871384f25fba9c869cfe21" + } } } } }, "type": "object" }, - "salesChannels": { + "productReviews": { "properties": { "links": { "type": "object", @@ -13942,7 +18420,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/salesChannels" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/productReviews" } } }, @@ -13953,136 +18431,19 @@ "properties": { "type": { "type": "string", - "example": "document_base_config_sales_channel" + "example": "product_review" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "01e78541ea343ed72424a5222796a4cd" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "DocumentBaseConfig": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "documentTypeId", - "name", - "global", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "logoId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "filenamePrefix": { - "type": "string" - }, - "filenameSuffix": { - "type": "string" - }, - "global": { - "type": "boolean" - }, - "documentNumber": { - "type": "string" - }, - "config": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "customFields": { - "type": "object" - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "documentType": { - "$ref": "#/components/schemas/DocumentType" - }, - "logo": { - "$ref": "#/components/schemas/Media" - }, - "salesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - }, - "type": "object" - }, - "DocumentBaseConfigSalesChannelJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "documentBaseConfigId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentBaseConfigId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "documentType": { + }, + "recoveryCustomer": { "properties": { "links": { "type": "object", @@ -14090,7 +18451,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentType" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/recoveryCustomer" } } }, @@ -14099,19 +18460,19 @@ "properties": { "type": { "type": "string", - "example": "document_type" + "example": "customer_recovery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "2e45fec65781ec559e2aea39372a55cd" + "example": "ce9d8d13e51bf43bc70a4be38950823b" } } } }, "type": "object" }, - "documentBaseConfig": { + "requestedGroup": { "properties": { "links": { "type": "object", @@ -14119,7 +18480,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentBaseConfig" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/requestedGroup" } } }, @@ -14128,19 +18489,19 @@ "properties": { "type": { "type": "string", - "example": "document_base_config" + "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "56e59df02965ebf8eadea49fa0aadd47" + "example": "46cf25a3f20102ff5e1e17526fb73b62" } } } }, "type": "object" }, - "salesChannel": { + "boundSalesChannel": { "properties": { "links": { "type": "object", @@ -14148,7 +18509,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/salesChannel" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/boundSalesChannel" } } }, @@ -14156,116 +18517,20 @@ "type": "object", "properties": { "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "DocumentBaseConfigSalesChannel": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "documentBaseConfigId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentBaseConfigId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "documentType": { - "$ref": "#/components/schemas/DocumentType" - }, - "documentBaseConfig": { - "$ref": "#/components/schemas/DocumentBaseConfig" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "type": "object" - }, - "DocumentTypeJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "technicalName", - "createdAt", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "technicalName": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "customFields": { - "type": "object" - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "documents": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "dfe8aec35136b1f62669b388a291a4c7" + } + } + } + }, + "type": "object" + }, + "wishlists": { "properties": { "links": { "type": "object", @@ -14273,7 +18538,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documents" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/wishlists" } } }, @@ -14284,11 +18549,11 @@ "properties": { "type": { "type": "string", - "example": "document" + "example": "customer_wishlist" }, "id": { "type": "string", - "example": "21f64da1e5792c8295b964d159a14491" + "example": "4ec38c6b2208529c1fadccc7d55d7947" } } } @@ -14296,7 +18561,7 @@ }, "type": "object" }, - "documentBaseConfigs": { + "createdBy": { "properties": { "links": { "type": "object", @@ -14304,30 +18569,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigs" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/createdBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "document_base_config" - }, - "id": { - "type": "string", - "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, - "documentBaseConfigSalesChannels": { + "updatedBy": { "properties": { "links": { "type": "object", @@ -14335,23 +18598,50 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigSalesChannels" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/updatedBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "document_base_config_sales_channel" - }, - "id": { - "type": "string", - "example": "9c990fde5b38ff70fc1a07bf84c12a17" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" + } + } + } + }, + "type": "object" + }, + "defaultPaymentMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultPaymentMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8f35e31802b72bf010a333999b26f3a6" } } } @@ -14366,25 +18656,165 @@ } ] }, - "DocumentType": { + "Customer": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "technicalName", - "createdAt", - "name" + "groupId", + "salesChannelId", + "languageId", + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", + "firstName", + "lastName", + "email", + "defaultPaymentMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "groupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "lastPaymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultBillingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultShippingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customerNumber": { "type": "string" }, - "technicalName": { + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "email": { + "type": "string" + }, + "title": { + "type": "string" + }, + "affiliateCode": { + "type": "string" + }, + "campaignCode": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "doubleOptInRegistration": { + "type": "boolean" + }, + "doubleOptInEmailSentDate": { + "type": "string", + "format": "date-time" + }, + "doubleOptInConfirmDate": { + "type": "string", + "format": "date-time" + }, + "hash": { + "type": "string" + }, + "guest": { + "type": "boolean" + }, + "firstLogin": { + "type": "string", + "format": "date-time" + }, + "lastLogin": { + "type": "string", + "format": "date-time" + }, + "birthday": { + "type": "string" + }, + "lastOrderDate": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "orderCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderTotalAmount": { + "type": "number", + "format": "float", + "readOnly": true + }, + "reviewCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "remoteAddress": { "type": "string" }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "requestedGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "boundSalesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultPaymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -14395,35 +18825,92 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" + "group": { + "$ref": "#/components/schemas/CustomerGroup" }, - "translated": { - "type": "object" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" }, - "documents": { + "language": { + "$ref": "#/components/schemas/Language" + }, + "lastPaymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + }, + "defaultBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "activeBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "defaultShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "activeShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + }, + "addresses": { "type": "array", "items": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/CustomerAddress" } }, - "documentBaseConfigs": { + "orderCustomers": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/OrderCustomer" } }, - "documentBaseConfigSalesChannels": { + "tags": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/Tag" + } + }, + "promotions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + }, + "productReviews": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + }, + "recoveryCustomer": { + "$ref": "#/components/schemas/CustomerRecovery" + }, + "requestedGroup": { + "$ref": "#/components/schemas/CustomerGroup" + }, + "boundSalesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "wishlists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" } + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + }, + "defaultPaymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" }, - "FlowJsonApi": { - "description": "Added since version: 6.4.6.0", + "CustomerAddressJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -14431,42 +18918,74 @@ { "required": [ "id", - "name", - "eventName", - "createdAt" + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { "type": "string" }, - "eventName": { + "lastName": { "type": "string" }, - "priority": { - "type": "integer", - "format": "int64" + "zipcode": { + "type": "string" }, - "invalid": { - "type": "boolean", - "readOnly": true + "city": { + "type": "string" }, - "active": { - "type": "boolean" + "company": { + "type": "string" }, - "description": { + "street": { + "type": "string" + }, + "department": { + "type": "string" + }, + "title": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "additionalAddressLine1": { + "type": "string" + }, + "additionalAddressLine2": { + "type": "string" + }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "customFields": { "type": "object" }, - "appFlowEventId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -14479,7 +18998,7 @@ }, "relationships": { "properties": { - "sequences": { + "customer": { "properties": { "links": { "type": "object", @@ -14487,30 +19006,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/sequences" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/customer" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow_sequence" - }, - "id": { - "type": "string", - "example": "eb6710ddc89dae357ae94ca3974b1e38" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "appFlowEvent": { + "country": { "properties": { "links": { "type": "object", @@ -14518,7 +19035,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/appFlowEvent" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country" } } }, @@ -14527,12 +19044,70 @@ "properties": { "type": { "type": "string", - "example": "app_flow_event" + "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d92d404135abc21e31337d9509cbe62f" + "example": "e909c2d7067ea37437cf97fe11d91bd0" + } + } + } + }, + "type": "object" + }, + "countryState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "cb6a9764567191fb74fe28d8d6a4819d" + } + } + } + }, + "type": "object" + }, + "salutation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "salutation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } @@ -14547,46 +19122,78 @@ } ] }, - "Flow": { - "description": "Added since version: 6.4.6.0", + "CustomerAddress": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "eventName", - "createdAt" + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { "type": "string" }, - "eventName": { + "lastName": { "type": "string" }, - "priority": { - "type": "integer", - "format": "int64" + "zipcode": { + "type": "string" }, - "invalid": { - "type": "boolean", - "readOnly": true + "city": { + "type": "string" }, - "active": { - "type": "boolean" + "company": { + "type": "string" }, - "description": { + "street": { + "type": "string" + }, + "department": { + "type": "string" + }, + "title": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "additionalAddressLine1": { + "type": "string" + }, + "additionalAddressLine2": { + "type": "string" + }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "customFields": { "type": "object" }, - "appFlowEventId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -14597,20 +19204,23 @@ "format": "date-time", "readOnly": true }, - "sequences": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" - } + "customer": { + "$ref": "#/components/schemas/Customer" }, - "appFlowEvent": { - "$ref": "#/components/schemas/AppFlowEvent" + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "FlowSequenceJsonApi": { - "description": "Added since version: 6.4.6.0", + "CustomerGroupJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -14618,49 +19228,36 @@ { "required": [ "id", - "flowId", - "createdAt" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "flowId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "ruleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "actionName": { + "name": { "type": "string" }, - "config": { - "type": "object" - }, - "position": { - "type": "integer", - "format": "int64" + "displayGross": { + "type": "boolean" }, - "displayGroup": { - "type": "integer", - "format": "int64" + "customFields": { + "type": "object" }, - "trueCase": { + "registrationActive": { "type": "boolean" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "registrationTitle": { + "type": "string" }, - "customFields": { - "type": "object" + "registrationIntroduction": { + "type": "string" }, - "appFlowActionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "registrationOnlyCompanyRegistration": { + "type": "boolean" + }, + "registrationSeoMetaDescription": { + "type": "string" }, "createdAt": { "type": "string", @@ -14672,67 +19269,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "flow": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/flow" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "cff5497121104c2b8e0cb41ed2083a9b" - } - } - } - }, - "type": "object" - }, - "rule": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/rule" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "rule" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "981c1e7b3795da18687613fbd66d4954" - } - } - } - }, - "type": "object" - }, - "parent": { + "customers": { "properties": { "links": { "type": "object", @@ -14740,28 +19282,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/parent" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customers" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow_sequence" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "4b6f7d34a58ba399f077685951d06738" + } } } } }, "type": "object" }, - "children": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -14769,7 +19313,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/children" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/salesChannels" } } }, @@ -14780,11 +19324,11 @@ "properties": { "type": { "type": "string", - "example": "flow_sequence" + "example": "sales_channel" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -14792,7 +19336,7 @@ }, "type": "object" }, - "appFlowAction": { + "registrationSalesChannels": { "properties": { "links": { "type": "object", @@ -14800,21 +19344,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/appFlowAction" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/registrationSalesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_flow_action" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8ba9ae8a60ecf9be421e333b95703a68" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "ffc8e76c1fe257d563b9d0024a50620b" + } } } } @@ -14829,53 +19375,40 @@ } ] }, - "FlowSequence": { - "description": "Added since version: 6.4.6.0", + "CustomerGroup": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "flowId", - "createdAt" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "flowId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "ruleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "actionName": { + "name": { "type": "string" }, - "config": { - "type": "object" - }, - "position": { - "type": "integer", - "format": "int64" + "displayGross": { + "type": "boolean" }, - "displayGroup": { - "type": "integer", - "format": "int64" + "customFields": { + "type": "object" }, - "trueCase": { + "registrationActive": { "type": "boolean" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "registrationTitle": { + "type": "string" }, - "customFields": { - "type": "object" + "registrationIntroduction": { + "type": "string" }, - "appFlowActionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "registrationOnlyCompanyRegistration": { + "type": "boolean" + }, + "registrationSeoMetaDescription": { + "type": "string" }, "createdAt": { "type": "string", @@ -14887,29 +19420,65 @@ "format": "date-time", "readOnly": true }, - "flow": { - "$ref": "#/components/schemas/Flow" + "translated": { + "type": "object" }, - "rule": { - "$ref": "#/components/schemas/Rule" + "customers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } }, - "parent": { - "$ref": "#/components/schemas/FlowSequence" + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } }, - "children": { + "registrationSalesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/SalesChannel" } + } + }, + "type": "object" + }, + "CustomerGroupRegistrationSalesChannels": { + "description": "Added since version: 6.3.1.0", + "required": [ + "customerGroupId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "appFlowAction": { - "$ref": "#/components/schemas/AppFlowAction" + "customerGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customerGroup": { + "$ref": "#/components/schemas/CustomerGroup" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "FlowTemplateJsonApi": { - "description": "Added since version: 6.4.18.0", + "CustomerRecoveryJsonApi": { + "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -14917,19 +19486,20 @@ { "required": [ "id", - "name", - "createdAt" + "hash", + "customerId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "hash": { "type": "string" }, - "config": { - "type": "object" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -14940,29 +19510,64 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "relationships": { + "properties": { + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-recovery/5c91cd3c845f51250c566f72e5fec3bf/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + } + }, + "type": "object" } }, "type": "object" } ] }, - "FlowTemplate": { - "description": "Added since version: 6.4.18.0", + "CustomerRecovery": { + "description": "Added since version: 6.1.0.0", "required": [ "id", - "name", - "createdAt" + "hash", + "customerId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "hash": { "type": "string" }, - "config": { - "type": "object" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -14973,11 +19578,43 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "customer": { + "$ref": "#/components/schemas/Customer" + } + }, + "type": "object" + }, + "CustomerTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "customerId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "GuidedShoppingAppointmentJsonApi": { + "CustomerWishlistJsonApi": { + "description": "Added since version: 6.3.4.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -14985,92 +19622,25 @@ { "required": [ "id", - "presentationId", - "salesChannelDomainId", - "presentationPath", - "mode", - "name", - "createdById", - "createdAt" + "customerId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "presentationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "guidedShoppingPresentationVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "active": { - "type": "boolean" - }, - "salesChannelDomainId": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "presentationPath": { - "type": "string" - }, - "accessibleFrom": { - "type": "string", - "format": "date-time" - }, - "accessibleTo": { - "type": "string", - "format": "date-time" - }, - "attendeeRuleIds": { - "type": "object" - }, - "guideUserId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mode": { - "type": "string" - }, - "message": { - "type": "string" - }, - "attendeeRestrictionType": { - "type": "string" - }, - "isPreview": { - "type": "boolean" - }, - "videoAudioSettings": { - "type": "string" - }, - "name": { - "type": "string" - }, - "startedAt": { - "type": "string", - "format": "date-time" - }, - "endedAt": { - "type": "string", - "format": "date-time" - }, - "default": { - "type": "boolean" - }, "customFields": { "type": "object" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -15081,12 +19651,40 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "presentation": { + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_wishlist_product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + }, + "customer": { "properties": { "links": { "type": "object", @@ -15094,7 +19692,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment/72e8b20caae21074a840ea2c263fd795/presentation" + "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/customer" } } }, @@ -15103,19 +19701,19 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_presentation" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "2486923a98e77fd0740381d01acd1782" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "videoChat": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -15123,7 +19721,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment/72e8b20caae21074a840ea2c263fd795/videoChat" + "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/salesChannel" } } }, @@ -15132,19 +19730,116 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_appointment_video_chat" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "b23b1765cc6500512065f5a39a713b75" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" - }, - "guideUser": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomerWishlist": { + "description": "Added since version: 6.3.4.0", + "required": [ + "id", + "customerId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "CustomerWishlistProductJsonApi": { + "description": "Added since version: 6.3.4.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "wishlistId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "wishlistId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "wishlist": { "properties": { "links": { "type": "object", @@ -15152,7 +19847,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment/72e8b20caae21074a840ea2c263fd795/guideUser" + "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/wishlist" } } }, @@ -15161,19 +19856,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "customer_wishlist" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7d58fd6cf68b2c4c00b51069f10a25eb" + "example": "723edf7c24638ed18d2fa831e647a5cc" } } } }, "type": "object" }, - "salesChannelDomain": { + "product": { "properties": { "links": { "type": "object", @@ -15181,7 +19876,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment/72e8b20caae21074a840ea2c263fd795/salesChannelDomain" + "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/product" } } }, @@ -15190,19 +19885,121 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_domain" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "29c8b34b04e94e35e95e8346954b7fb4" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" - }, - "attendees": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomerWishlistProduct": { + "description": "Added since version: 6.3.4.0", + "required": [ + "id", + "productId", + "wishlistId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "wishlistId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "wishlist": { + "$ref": "#/components/schemas/CustomerWishlist" + }, + "product": { + "$ref": "#/components/schemas/Product" + } + }, + "type": "object" + }, + "DeliveryTimeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "min", + "max", + "unit" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "min": { + "type": "integer", + "format": "int64" + }, + "max": { + "type": "integer", + "format": "int64" + }, + "unit": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "shippingMethods": { "properties": { "links": { "type": "object", @@ -15210,7 +20007,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment/72e8b20caae21074a840ea2c263fd795/attendees" + "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/shippingMethods" } } }, @@ -15221,11 +20018,11 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_appointment_attendee" + "example": "shipping_method" }, "id": { "type": "string", - "example": "4d77992a742c290d1e37290f3986fd4e" + "example": "8268b0a6c902fbde485094c2f627b854" } } } @@ -15233,36 +20030,7 @@ }, "type": "object" }, - "createdBy": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/guided-shopping-appointment/72e8b20caae21074a840ea2c263fd795/createdBy" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" - } - } - } - }, - "type": "object" - }, - "updatedBy": { + "products": { "properties": { "links": { "type": "object", @@ -15270,21 +20038,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment/72e8b20caae21074a840ea2c263fd795/updatedBy" + "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/products" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } } } } @@ -15299,95 +20069,37 @@ } ] }, - "GuidedShoppingAppointment": { + "DeliveryTime": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "presentationId", - "salesChannelDomainId", - "presentationPath", - "mode", "name", - "createdById", - "createdAt" + "min", + "max", + "unit" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "presentationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "guidedShoppingPresentationVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "active": { - "type": "boolean" - }, - "salesChannelDomainId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "presentationPath": { - "type": "string" - }, - "accessibleFrom": { - "type": "string", - "format": "date-time" - }, - "accessibleTo": { - "type": "string", - "format": "date-time" - }, - "attendeeRuleIds": { - "type": "object" - }, - "guideUserId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mode": { - "type": "string" - }, - "message": { - "type": "string" - }, - "attendeeRestrictionType": { - "type": "string" - }, - "isPreview": { - "type": "boolean" - }, - "videoAudioSettings": { - "type": "string" - }, "name": { "type": "string" }, - "startedAt": { - "type": "string", - "format": "date-time" + "min": { + "type": "integer", + "format": "int64" }, - "endedAt": { - "type": "string", - "format": "date-time" + "max": { + "type": "integer", + "format": "int64" }, - "default": { - "type": "boolean" + "unit": { + "type": "string" }, "customFields": { "type": "object" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -15401,34 +20113,23 @@ "translated": { "type": "object" }, - "presentation": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - }, - "videoChat": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - }, - "guideUser": { - "$ref": "#/components/schemas/User" - }, - "salesChannelDomain": { - "$ref": "#/components/schemas/SalesChannelDomain" - }, - "attendees": { + "shippingMethods": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + "$ref": "#/components/schemas/ShippingMethod" } }, - "createdBy": { - "$ref": "#/components/schemas/User" - }, - "updatedBy": { - "$ref": "#/components/schemas/User" + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } }, "type": "object" }, - "GuidedShoppingAppointmentAttendeeJsonApi": { + "DocumentJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -15436,56 +20137,61 @@ { "required": [ "id", - "appointmentId", - "type", - "createdAt" + "documentTypeId", + "orderId", + "config", + "deepLinkCode", + "fileType" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appointmentId": { + "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "guideCartPermissionsGranted": { - "type": "boolean" + "referencedDocumentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "attendeeSubmittedAt": { + "orderId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "documentMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "userId": { + "documentA11yMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "videoUserId": { - "type": "string" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "attendeeName": { - "type": "string" + "config": { + "type": "object" }, - "attendeeEmail": { - "type": "string" + "sent": { + "type": "boolean" }, - "type": { + "static": { + "type": "boolean" + }, + "deepLinkCode": { "type": "string" }, - "invitationStatus": { + "documentNumber": { "type": "string" }, - "joinedAt": { - "type": "string", - "format": "date-time" + "customFields": { + "type": "object" }, - "lastActive": { - "type": "string", - "format": "date-time" + "fileType": { + "type": "string" }, "createdAt": { "type": "string", @@ -15499,7 +20205,7 @@ }, "relationships": { "properties": { - "appointment": { + "documentType": { "properties": { "links": { "type": "object", @@ -15507,7 +20213,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment-attendee/1c6e84dd56d3d017733b559a107cf2aa/appointment" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentType" } } }, @@ -15516,19 +20222,19 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_appointment" + "example": "document_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "b1caa385c37f1fec467494c8fde4f49b" + "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" }, - "customer": { + "order": { "properties": { "links": { "type": "object", @@ -15536,7 +20242,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment-attendee/1c6e84dd56d3d017733b559a107cf2aa/customer" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/order" } } }, @@ -15545,19 +20251,19 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "user": { + "referencedDocument": { "properties": { "links": { "type": "object", @@ -15565,7 +20271,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment-attendee/1c6e84dd56d3d017733b559a107cf2aa/user" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/referencedDocument" } } }, @@ -15574,19 +20280,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "document" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ee11cbb19052e40b07aac0ca060c23ee" + "example": "75c3c346b0ef4f319e71925ce164a9ae" } } } }, "type": "object" }, - "interactions": { + "dependentDocuments": { "properties": { "links": { "type": "object", @@ -15594,7 +20300,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment-attendee/1c6e84dd56d3d017733b559a107cf2aa/interactions" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/dependentDocuments" } } }, @@ -15605,11 +20311,11 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_interaction" + "example": "document" }, "id": { "type": "string", - "example": "85aa9c704a544e104741012bf72b6572" + "example": "e74b269b7d5f269051463569677da2a0" } } } @@ -15617,7 +20323,7 @@ }, "type": "object" }, - "productCollections": { + "documentMediaFile": { "properties": { "links": { "type": "object", @@ -15625,23 +20331,50 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment-attendee/1c6e84dd56d3d017733b559a107cf2aa/productCollections" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentMediaFile" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_attendee_product_collection" - }, - "id": { - "type": "string", - "example": "3fa1ecbee1fa3d24671a2e81d9b71d17" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ac7db1e6be481d6422fc63700e08279d" + } + } + } + }, + "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" } } } @@ -15656,59 +20389,65 @@ } ] }, - "GuidedShoppingAppointmentAttendee": { + "Document": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "appointmentId", - "type", - "createdAt" + "documentTypeId", + "orderId", + "config", + "deepLinkCode", + "fileType" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appointmentId": { + "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "guideCartPermissionsGranted": { - "type": "boolean" + "referencedDocumentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "attendeeSubmittedAt": { + "orderId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "documentMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "userId": { + "documentA11yMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "videoUserId": { - "type": "string" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "attendeeName": { - "type": "string" + "config": { + "type": "object" }, - "attendeeEmail": { - "type": "string" + "sent": { + "type": "boolean" }, - "type": { + "static": { + "type": "boolean" + }, + "deepLinkCode": { "type": "string" }, - "invitationStatus": { + "documentNumber": { "type": "string" }, - "joinedAt": { - "type": "string", - "format": "date-time" + "customFields": { + "type": "object" }, - "lastActive": { - "type": "string", - "format": "date-time" + "fileType": { + "type": "string" }, "createdAt": { "type": "string", @@ -15720,31 +20459,32 @@ "format": "date-time", "readOnly": true }, - "appointment": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" + "documentType": { + "$ref": "#/components/schemas/DocumentType" }, - "customer": { - "$ref": "#/components/schemas/Customer" + "order": { + "$ref": "#/components/schemas/Order" }, - "user": { - "$ref": "#/components/schemas/User" + "referencedDocument": { + "$ref": "#/components/schemas/Document" }, - "interactions": { + "dependentDocuments": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" + "$ref": "#/components/schemas/Document" } }, - "productCollections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - } + "documentMediaFile": { + "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "GuidedShoppingAppointmentVideoChatJsonApi": { + "DocumentBaseConfigJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -15752,34 +20492,38 @@ { "required": [ "id", - "appointmentId", - "createdAt" + "documentTypeId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appointmentId": { + "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "logoId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "ownerToken": { + "name": { "type": "string" }, - "userToken": { + "filenamePrefix": { "type": "string" }, - "url": { + "filenameSuffix": { "type": "string" }, - "startAsBroadcast": { + "global": { "type": "boolean" }, - "customFields": { + "documentNumber": { + "type": "string" + }, + "config": { "type": "object" }, "createdAt": { @@ -15787,6 +20531,9 @@ "format": "date-time", "readOnly": true }, + "customFields": { + "type": "object" + }, "updatedAt": { "type": "string", "format": "date-time", @@ -15794,7 +20541,36 @@ }, "relationships": { "properties": { - "appointment": { + "documentType": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/documentType" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2e45fec65781ec559e2aea39372a55cd" + } + } + } + }, + "type": "object" + }, + "logo": { "properties": { "links": { "type": "object", @@ -15802,7 +20578,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment-video-chat/ff6e704f90e15236139b7cdd89b9b667/appointment" + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/logo" } } }, @@ -15811,12 +20587,43 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_appointment" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "b1caa385c37f1fec467494c8fde4f49b" + "example": "96d6f2e7e1f705ab5e59c84a6dc009b2" + } + } + } + }, + "type": "object" + }, + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config_sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } } } } @@ -15831,37 +20638,42 @@ } ] }, - "GuidedShoppingAppointmentVideoChat": { + "DocumentBaseConfig": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "appointmentId", - "createdAt" + "documentTypeId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appointmentId": { + "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "logoId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "ownerToken": { + "name": { "type": "string" }, - "userToken": { + "filenamePrefix": { "type": "string" }, - "url": { + "filenameSuffix": { "type": "string" }, - "startAsBroadcast": { + "global": { "type": "boolean" }, - "customFields": { + "documentNumber": { + "type": "string" + }, + "config": { "type": "object" }, "createdAt": { @@ -15869,18 +20681,31 @@ "format": "date-time", "readOnly": true }, + "customFields": { + "type": "object" + }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, - "appointment": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" + "documentType": { + "$ref": "#/components/schemas/DocumentType" + }, + "logo": { + "$ref": "#/components/schemas/Media" + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } } }, "type": "object" }, - "GuidedShoppingAttendeeProductCollectionJsonApi": { + "DocumentBaseConfigSalesChannelJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -15888,31 +20713,25 @@ { "required": [ "id", - "attendeeId", - "productId", - "alias", - "createdAt" + "documentBaseConfigId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "attendeeId": { + "documentBaseConfigId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "alias": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -15925,7 +20744,7 @@ }, "relationships": { "properties": { - "attendee": { + "documentType": { "properties": { "links": { "type": "object", @@ -15933,7 +20752,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-attendee-product-collection/b6b9e6db620045c70dbf40f9f18d75db/attendee" + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentType" } } }, @@ -15942,19 +20761,19 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_appointment_attendee" + "example": "document_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" + "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" }, - "product": { + "documentBaseConfig": { "properties": { "links": { "type": "object", @@ -15962,7 +20781,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-attendee-product-collection/b6b9e6db620045c70dbf40f9f18d75db/product" + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentBaseConfig" } } }, @@ -15971,12 +20790,41 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "document_base_config" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "56e59df02965ebf8eadea49fa0aadd47" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -15991,34 +20839,29 @@ } ] }, - "GuidedShoppingAttendeeProductCollection": { + "DocumentBaseConfigSalesChannel": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "attendeeId", - "productId", - "alias", - "createdAt" + "documentBaseConfigId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "attendeeId": { + "documentBaseConfigId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "alias": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -16029,16 +20872,20 @@ "format": "date-time", "readOnly": true }, - "attendee": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + "documentType": { + "$ref": "#/components/schemas/DocumentType" + }, + "documentBaseConfig": { + "$ref": "#/components/schemas/DocumentBaseConfig" }, - "product": { - "$ref": "#/components/schemas/Product" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "GuidedShoppingInteractionJsonApi": { + "DocumentTypeJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -16046,10 +20893,8 @@ { "required": [ "id", - "name", - "triggeredAt", - "attendeeId", - "createdAt" + "technicalName", + "name" ], "properties": { "id": { @@ -16059,20 +20904,8 @@ "name": { "type": "string" }, - "expiresAt": { - "type": "string", - "format": "date-time" - }, - "triggeredAt": { - "type": "string", - "format": "date-time" - }, - "payload": { - "type": "object" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "technicalName": { + "type": "string" }, "createdAt": { "type": "string", @@ -16084,9 +20917,15 @@ "format": "date-time", "readOnly": true }, + "customFields": { + "type": "object" + }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "attendee": { + "documents": { "properties": { "links": { "type": "object", @@ -16094,21 +20933,85 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-interaction/af36f528ed70da8c2478965b40809b79/attendee" + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documents" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "example": "21f64da1e5792c8295b964d159a14491" + } + } + } + } + }, + "type": "object" + }, + "documentBaseConfigs": { + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "guided_shopping_appointment_attendee" - }, - "id": { + "format": "uri-reference", + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config" + }, + "id": { + "type": "string", + "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" + } + } + } + } + }, + "type": "object" + }, + "documentBaseConfigSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" + "format": "uri-reference", + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config_sales_channel" + }, + "id": { + "type": "string", + "example": "9c990fde5b38ff70fc1a07bf84c12a17" + } } } } @@ -16123,13 +21026,12 @@ } ] }, - "GuidedShoppingInteraction": { + "DocumentType": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "triggeredAt", - "attendeeId", - "createdAt" + "technicalName", + "name" ], "properties": { "id": { @@ -16139,20 +21041,8 @@ "name": { "type": "string" }, - "expiresAt": { - "type": "string", - "format": "date-time" - }, - "triggeredAt": { - "type": "string", - "format": "date-time" - }, - "payload": { - "type": "object" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "technicalName": { + "type": "string" }, "createdAt": { "type": "string", @@ -16164,13 +21054,35 @@ "format": "date-time", "readOnly": true }, - "attendee": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + "customFields": { + "type": "object" + }, + "translated": { + "type": "object" + }, + "documents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, + "documentBaseConfigs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + }, + "documentBaseConfigSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } } }, "type": "object" }, - "GuidedShoppingPresentationJsonApi": { + "FlowJsonApi": { + "description": "Added since version: 6.4.6.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -16178,41 +21090,38 @@ { "required": [ "id", - "createdById", - "createdAt", - "name" + "name", + "eventName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "active": { - "type": "boolean" + "eventName": { + "type": "string" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "priority": { + "type": "integer", + "format": "int64" }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "invalid": { + "type": "boolean", + "readOnly": true }, - "name": { + "active": { + "type": "boolean" + }, + "description": { "type": "string" }, "customFields": { "type": "object" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { + "appFlowEventId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -16226,72 +21135,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "parent": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/guided-shopping-presentation/456c93075050cca0e3e24aeecf897330/parent" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" - } - } - } - }, - "type": "object" - }, - "appointments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/guided-shopping-presentation/456c93075050cca0e3e24aeecf897330/appointments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "2417b53255206bdce189add39d85fca1" - } - } - } - } - }, - "type": "object" - }, - "cmsPages": { + "sequences": { "properties": { "links": { "type": "object", @@ -16299,7 +21145,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-presentation/456c93075050cca0e3e24aeecf897330/cmsPages" + "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/sequences" } } }, @@ -16310,11 +21156,11 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_presentation_cms_page" + "example": "flow_sequence" }, "id": { "type": "string", - "example": "e676148cc6ffb82b89b3903ecaed2d16" + "example": "eb6710ddc89dae357ae94ca3974b1e38" } } } @@ -16322,36 +21168,7 @@ }, "type": "object" }, - "createdBy": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/guided-shopping-presentation/456c93075050cca0e3e24aeecf897330/createdBy" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" - } - } - } - }, - "type": "object" - }, - "updatedBy": { + "appFlowEvent": { "properties": { "links": { "type": "object", @@ -16359,7 +21176,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-presentation/456c93075050cca0e3e24aeecf897330/updatedBy" + "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/appFlowEvent" } } }, @@ -16368,12 +21185,12 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "app_flow_event" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "example": "d92d404135abc21e31337d9509cbe62f" } } } @@ -16388,44 +21205,42 @@ } ] }, - "GuidedShoppingPresentation": { + "Flow": { + "description": "Added since version: 6.4.6.0", "required": [ "id", - "createdById", - "createdAt", - "name" + "name", + "eventName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "active": { - "type": "boolean" + "eventName": { + "type": "string" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "priority": { + "type": "integer", + "format": "int64" + }, + "invalid": { + "type": "boolean", + "readOnly": true }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "active": { + "type": "boolean" }, - "name": { + "description": { "type": "string" }, "customFields": { "type": "object" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { + "appFlowEventId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -16439,35 +21254,20 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "parent": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - }, - "appointments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - } - }, - "cmsPages": { + "sequences": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + "$ref": "#/components/schemas/FlowSequence" } }, - "createdBy": { - "$ref": "#/components/schemas/User" - }, - "updatedBy": { - "$ref": "#/components/schemas/User" + "appFlowEvent": { + "$ref": "#/components/schemas/AppFlowEvent" } }, "type": "object" }, - "GuidedShoppingPresentationCmsPageJsonApi": { - "description": "Added since version: 6.0.0.0", + "FlowSequenceJsonApi": { + "description": "Added since version: 6.4.6.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -16475,61 +21275,48 @@ { "required": [ "id", - "presentationId", - "cmsPageId", - "createdAt" + "flowId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "presentationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "guidedShoppingPresentationVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageId": { + "flowId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { + "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "title": { + "actionName": { "type": "string" }, - "customFields": { + "config": { "type": "object" }, - "slotConfig": { - "type": "object" + "position": { + "type": "integer", + "format": "int64" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "displayGroup": { + "type": "integer", + "format": "int64" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "trueCase": { + "type": "boolean" }, - "productStreamId": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "pickedProductIds": { + "customFields": { "type": "object" }, - "position": { - "type": "integer", - "format": "int64" - }, - "isInstantListing": { - "type": "boolean" + "appFlowActionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -16541,12 +21328,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "presentation": { + "flow": { "properties": { "links": { "type": "object", @@ -16554,7 +21338,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-presentation-cms-page/57363e7d22ac102ed71cd68204fd16cc/presentation" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/flow" } } }, @@ -16563,19 +21347,19 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_presentation" + "example": "flow" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "2486923a98e77fd0740381d01acd1782" + "example": "cff5497121104c2b8e0cb41ed2083a9b" } } } }, "type": "object" }, - "cmsPage": { + "rule": { "properties": { "links": { "type": "object", @@ -16583,7 +21367,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-presentation-cms-page/57363e7d22ac102ed71cd68204fd16cc/cmsPage" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/rule" } } }, @@ -16592,19 +21376,19 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" + "example": "981c1e7b3795da18687613fbd66d4954" } } } }, "type": "object" }, - "product": { + "parent": { "properties": { "links": { "type": "object", @@ -16612,7 +21396,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-presentation-cms-page/57363e7d22ac102ed71cd68204fd16cc/product" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/parent" } } }, @@ -16621,19 +21405,50 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "flow_sequence" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "productStream": { + "children": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/children" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow_sequence" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } + } + } + } + }, + "type": "object" + }, + "appFlowAction": { "properties": { "links": { "type": "object", @@ -16641,7 +21456,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-presentation-cms-page/57363e7d22ac102ed71cd68204fd16cc/productStream" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/appFlowAction" } } }, @@ -16650,12 +21465,12 @@ "properties": { "type": { "type": "string", - "example": "product_stream" + "example": "app_flow_action" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "49561f6faa0badfce831a183d2ec7c2f" + "example": "8ba9ae8a60ecf9be421e333b95703a68" } } } @@ -16670,65 +21485,52 @@ } ] }, - "GuidedShoppingPresentationCmsPage": { - "description": "Added since version: 6.0.0.0", + "FlowSequence": { + "description": "Added since version: 6.4.6.0", "required": [ "id", - "presentationId", - "cmsPageId", - "createdAt" + "flowId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "presentationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "guidedShoppingPresentationVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageId": { + "flowId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { + "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "title": { + "actionName": { "type": "string" }, - "customFields": { + "config": { "type": "object" }, - "slotConfig": { - "type": "object" + "position": { + "type": "integer", + "format": "int64" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "displayGroup": { + "type": "integer", + "format": "int64" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "trueCase": { + "type": "boolean" }, - "productStreamId": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "pickedProductIds": { + "customFields": { "type": "object" }, - "position": { - "type": "integer", - "format": "int64" - }, - "isInstantListing": { - "type": "boolean" + "appFlowActionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -16740,20 +21542,90 @@ "format": "date-time", "readOnly": true }, - "translated": { + "flow": { + "$ref": "#/components/schemas/Flow" + }, + "rule": { + "$ref": "#/components/schemas/Rule" + }, + "parent": { + "$ref": "#/components/schemas/FlowSequence" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + }, + "appFlowAction": { + "$ref": "#/components/schemas/AppFlowAction" + } + }, + "type": "object" + }, + "FlowTemplateJsonApi": { + "description": "Added since version: 6.4.18.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "config": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, "type": "object" + } + ] + }, + "FlowTemplate": { + "description": "Added since version: 6.4.18.0", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "presentation": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" + "name": { + "type": "string" }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "config": { + "type": "object" }, - "product": { - "$ref": "#/components/schemas/Product" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "type": "object" @@ -16769,8 +21641,7 @@ "id", "originalName", "path", - "expireDate", - "createdAt" + "expireDate" ], "properties": { "id": { @@ -16849,8 +21720,7 @@ "id", "originalName", "path", - "expireDate", - "createdAt" + "expireDate" ], "properties": { "id": { @@ -16902,8 +21772,7 @@ "activity", "state", "records", - "config", - "createdAt" + "config" ], "properties": { "id": { @@ -17120,8 +21989,7 @@ "activity", "state", "records", - "config", - "createdAt" + "config" ], "properties": { "id": { @@ -17207,17 +22075,13 @@ "sourceEntity", "fileType", "delimiter", - "enclosure", - "createdAt" + "enclosure" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, "label": { "type": "string" }, @@ -17248,6 +22112,12 @@ "config": { "type": "object" }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -17310,17 +22180,13 @@ "sourceEntity", "fileType", "delimiter", - "enclosure", - "createdAt" + "enclosure" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, "label": { "type": "string" }, @@ -17351,6 +22217,12 @@ "config": { "type": "object" }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -17384,8 +22256,7 @@ "id", "label", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -17537,8 +22408,7 @@ "id", "label", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -17663,7 +22533,6 @@ { "required": [ "id", - "createdAt", "name", "url" ], @@ -17857,7 +22726,6 @@ "description": "Added since version: 6.4.0.0", "required": [ "id", - "createdAt", "name", "url" ], @@ -18013,8 +22881,7 @@ "required": [ "id", "localeId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -18049,42 +22916,6 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "presentationTranslation": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/presentationTranslation" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation_translation" - }, - "id": { - "type": "string", - "example": "e22d79f2b1909484a375a5dc228ef751" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "relationships": { "properties": { "parent": { @@ -18526,8 +23357,7 @@ "required": [ "id", "localeId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -18562,42 +23392,6 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "presentationTranslation": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/presentationTranslation" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation_translation" - }, - "id": { - "type": "string", - "example": "e22d79f2b1909484a375a5dc228ef751" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "parent": { "$ref": "#/components/schemas/Language" }, @@ -18683,7 +23477,6 @@ "required": [ "id", "code", - "createdAt", "name", "territory" ], @@ -18794,7 +23587,6 @@ "required": [ "id", "code", - "createdAt", "name", "territory" ], @@ -18851,8 +23643,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -18893,8 +23684,7 @@ "LogEntry": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -18939,7 +23729,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -19026,7 +23815,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -19087,7 +23875,6 @@ "required": [ "id", "mailTemplateTypeId", - "createdAt", "subject", "contentHtml", "contentPlain" @@ -19210,7 +23997,6 @@ "required": [ "id", "mailTemplateTypeId", - "createdAt", "subject", "contentHtml", "contentPlain" @@ -19318,7 +24104,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -19400,7 +24185,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -19456,8 +24240,7 @@ "id", "productId", "categoryId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -19597,8 +24380,7 @@ "id", "productId", "categoryId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -19655,8 +24437,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -19672,8 +24453,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mimeType": { - "type": "string", - "readOnly": true + "type": "string" }, "fileExtension": { "type": "string", @@ -19685,8 +24465,7 @@ "readOnly": true }, "fileName": { - "type": "string", - "readOnly": true + "type": "string" }, "fileSize": { "type": "integer", @@ -19727,6 +24506,9 @@ "customFields": { "type": "object" }, + "fileHash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -20529,8 +25311,7 @@ "Media": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -20546,8 +25327,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mimeType": { - "type": "string", - "readOnly": true + "type": "string" }, "fileExtension": { "type": "string", @@ -20559,8 +25339,7 @@ "readOnly": true }, "fileName": { - "type": "string", - "readOnly": true + "type": "string" }, "fileSize": { "type": "integer", @@ -20601,6 +25380,9 @@ "customFields": { "type": "object" }, + "fileHash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -20825,8 +25607,7 @@ { "required": [ "id", - "entity", - "createdAt" + "entity" ], "properties": { "id": { @@ -20892,8 +25673,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "entity", - "createdAt" + "entity" ], "properties": { "id": { @@ -20932,8 +25712,7 @@ "required": [ "id", "configurationId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -21144,8 +25923,7 @@ "required": [ "id", "configurationId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -21224,8 +26002,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -21336,8 +26113,7 @@ "MediaFolderConfiguration": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -21455,8 +26231,7 @@ "id", "mediaId", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -21542,8 +26317,7 @@ "id", "mediaId", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -21600,8 +26374,7 @@ "required": [ "id", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -21675,8 +26448,7 @@ "required": [ "id", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -21726,8 +26498,7 @@ "status", "hash", "languageId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -21926,8 +26697,7 @@ "status", "hash", "languageId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -22046,8 +26816,7 @@ "required": [ "id", "status", - "message", - "createdAt" + "message" ], "properties": { "id": { @@ -22161,8 +26930,7 @@ "required": [ "id", "status", - "message", - "createdAt" + "message" ], "properties": { "id": { @@ -22225,7 +26993,6 @@ "global", "pattern", "start", - "createdAt", "name" ], "properties": { @@ -22376,7 +27143,6 @@ "global", "pattern", "start", - "createdAt", "name" ], "properties": { @@ -22445,8 +27211,7 @@ "required": [ "id", "numberRangeId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -22577,8 +27342,7 @@ "required": [ "id", "numberRangeId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -22629,8 +27393,7 @@ "required": [ "id", "numberRangeId", - "lastValue", - "createdAt" + "lastValue" ], "properties": { "id": { @@ -22699,8 +27462,7 @@ "required": [ "id", "numberRangeId", - "lastValue", - "createdAt" + "lastValue" ], "properties": { "id": { @@ -22741,7 +27503,6 @@ "required": [ "id", "global", - "createdAt", "typeName" ], "properties": { @@ -22851,7 +27612,6 @@ "required": [ "id", "global", - "createdAt", "typeName" ], "properties": { @@ -22916,8 +27676,7 @@ "currencyFactor", "stateId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -23614,8 +28373,7 @@ "currencyFactor", "stateId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -23949,8 +28707,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -24017,6 +28774,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -24196,8 +28957,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -24264,6 +29024,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -24310,8 +29074,7 @@ "orderId", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -24482,8 +29245,7 @@ "orderId", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -24575,10 +29337,8 @@ "shippingOrderAddressId", "shippingMethodId", "stateId", - "trackingCodes", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -24862,10 +29622,8 @@ "shippingOrderAddressId", "shippingMethodId", "stateId", - "trackingCodes", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -25015,8 +29773,7 @@ "required": [ "id", "orderDeliveryId", - "orderLineItemId", - "createdAt" + "orderLineItemId" ], "properties": { "id": { @@ -25198,8 +29955,7 @@ "required": [ "id", "orderDeliveryId", - "orderLineItemId", - "createdAt" + "orderLineItemId" ], "properties": { "id": { @@ -25330,11 +30086,9 @@ "identifier", "quantity", "label", - "position", "states", "price", - "children", - "createdAt" + "children" ], "properties": { "id": { @@ -25363,8 +30117,7 @@ }, "promotionId": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", @@ -25787,11 +30540,9 @@ "identifier", "quantity", "label", - "position", "states", "price", - "children", - "createdAt" + "children" ], "properties": { "id": { @@ -25820,8 +30571,7 @@ }, "promotionId": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", @@ -26011,8 +30761,7 @@ "orderLineItemId", "mediaId", "position", - "accessGranted", - "createdAt" + "accessGranted" ], "properties": { "id": { @@ -26130,8 +30879,7 @@ "orderLineItemId", "mediaId", "position", - "accessGranted", - "createdAt" + "accessGranted" ], "properties": { "id": { @@ -26227,8 +30975,7 @@ "orderId", "paymentMethodId", "amount", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -26308,6 +31055,9 @@ }, "type": "object" }, + "validationData": { + "type": "object" + }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -26460,8 +31210,7 @@ "orderId", "paymentMethodId", "amount", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -26541,6 +31290,9 @@ }, "type": "object" }, + "validationData": { + "type": "object" + }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -26587,8 +31339,7 @@ "id", "orderTransactionId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -26789,8 +31540,7 @@ "id", "orderTransactionId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -26912,8 +31662,7 @@ "id", "captureId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -27117,8 +31866,7 @@ "id", "captureId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -27243,8 +31991,7 @@ "id", "refundId", "orderLineItemId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -27425,8 +32172,7 @@ "id", "refundId", "orderLineItemId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -27551,7 +32297,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -27901,7 +32646,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -28049,7 +32793,6 @@ "name", "autoload", "version", - "createdAt", "label" ], "properties": { @@ -28183,7 +32926,6 @@ "name", "autoload", "version", - "createdAt", "label" ], "properties": { @@ -28290,7 +33032,6 @@ "price", "productNumber", "stock", - "createdAt", "name" ], "properties": { @@ -28346,6 +33087,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -28355,7 +33100,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "productNumber": { "type": "string" @@ -28434,7 +33182,10 @@ "type": "boolean" }, "purchasePrices": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "markAsTopseller": { "type": "boolean" @@ -28579,73 +33330,6 @@ "translated": { "type": "object" }, - "extensions": { - "properties": { - "attendeeProductCollections": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/attendeeProductCollections" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_attendee_product_collection" - }, - "id": { - "type": "string", - "example": "0a7b3b2f4b81f36910a74f22826f35df" - } - } - } - } - }, - "type": "object" - }, - "presentationCmsPages": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/presentationCmsPages" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation_cms_page" - }, - "id": { - "type": "string", - "example": "30c725082807b69914fddd7e82d0d741" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "relationships": { "properties": { "downloads": { @@ -29576,7 +34260,6 @@ "price", "productNumber", "stock", - "createdAt", "name" ], "properties": { @@ -29632,6 +34315,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -29641,7 +34328,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "productNumber": { "type": "string" @@ -29720,7 +34410,10 @@ "type": "boolean" }, "purchasePrices": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "markAsTopseller": { "type": "boolean" @@ -29865,73 +34558,6 @@ "translated": { "type": "object" }, - "extensions": { - "properties": { - "attendeeProductCollections": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/attendeeProductCollections" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_attendee_product_collection" - }, - "id": { - "type": "string", - "example": "0a7b3b2f4b81f36910a74f22826f35df" - } - } - } - } - }, - "type": "object" - }, - "presentationCmsPages": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/presentationCmsPages" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation_cms_page" - }, - "id": { - "type": "string", - "example": "30c725082807b69914fddd7e82d0d741" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "downloads": { "type": "array", "items": { @@ -30170,8 +34796,7 @@ "required": [ "id", "productId", - "optionId", - "createdAt" + "optionId" ], "properties": { "id": { @@ -30320,8 +34945,7 @@ "required": [ "id", "productId", - "optionId", - "createdAt" + "optionId" ], "properties": { "id": { @@ -30390,10 +35014,7 @@ "required": [ "id", "name", - "position", - "type", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -30552,10 +35173,7 @@ "required": [ "id", "name", - "position", - "type", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -30635,8 +35253,7 @@ "required": [ "id", "crossSellingId", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -30742,8 +35359,7 @@ "required": [ "id", "crossSellingId", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -30827,8 +35443,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -30941,8 +35556,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -31010,8 +35624,7 @@ "encoding", "fileFormat", "generateByCronjob", - "interval", - "createdAt" + "interval" ], "properties": { "id": { @@ -31258,8 +35871,7 @@ "encoding", "fileFormat", "generateByCronjob", - "interval", - "createdAt" + "interval" ], "properties": { "id": { @@ -31364,7 +35976,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -31439,7 +36050,6 @@ "description": "Added since version: 6.3.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -31581,7 +36191,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -31696,7 +36305,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -31759,8 +36367,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -31904,8 +36511,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -32004,8 +36610,7 @@ "productId", "ruleId", "price", - "quantityStart", - "createdAt" + "quantityStart" ], "properties": { "id": { @@ -32029,7 +36634,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "quantityStart": { "type": "integer", @@ -32127,8 +36735,7 @@ "productId", "ruleId", "price", - "quantityStart", - "createdAt" + "quantityStart" ], "properties": { "id": { @@ -32152,7 +36759,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "quantityStart": { "type": "integer", @@ -32229,8 +36839,7 @@ "salesChannelId", "languageId", "title", - "content", - "createdAt" + "content" ], "properties": { "id": { @@ -32426,8 +37035,7 @@ "salesChannelId", "languageId", "title", - "content", - "createdAt" + "content" ], "properties": { "id": { @@ -32513,10 +37121,7 @@ { "required": [ "id", - "languageId", - "andLogic", - "minSearchLength", - "createdAt" + "languageId" ], "properties": { "id": { @@ -32624,10 +37229,7 @@ "description": "Added since version: 6.3.5.0", "required": [ "id", - "languageId", - "andLogic", - "minSearchLength", - "createdAt" + "languageId" ], "properties": { "id": { @@ -32683,11 +37285,7 @@ "required": [ "id", "searchConfigId", - "field", - "tokenize", - "searchable", - "ranking", - "createdAt" + "field" ], "properties": { "id": { @@ -32798,11 +37396,7 @@ "required": [ "id", "searchConfigId", - "field", - "tokenize", - "searchable", - "ranking", - "createdAt" + "field" ], "properties": { "id": { @@ -32861,8 +37455,7 @@ "languageId", "productId", "keyword", - "ranking", - "createdAt" + "ranking" ], "properties": { "id": { @@ -32977,8 +37570,7 @@ "languageId", "productId", "keyword", - "ranking", - "createdAt" + "ranking" ], "properties": { "id": { @@ -33040,7 +37632,6 @@ "priority", "active", "fields", - "createdAt", "label" ], "properties": { @@ -33093,7 +37684,6 @@ "priority", "active", "fields", - "createdAt", "label" ], "properties": { @@ -33145,7 +37735,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -33183,42 +37772,6 @@ "translated": { "type": "object" }, - "extensions": { - "properties": { - "presentationCmsPages": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/presentationCmsPages" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation_cms_page" - }, - "id": { - "type": "string", - "example": "30c725082807b69914fddd7e82d0d741" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "relationships": { "properties": { "filters": { @@ -33357,7 +37910,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -33395,42 +37947,6 @@ "translated": { "type": "object" }, - "extensions": { - "properties": { - "presentationCmsPages": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/presentationCmsPages" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation_cms_page" - }, - "id": { - "type": "string", - "example": "30c725082807b69914fddd7e82d0d741" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "filters": { "type": "array", "items": { @@ -33468,8 +37984,7 @@ "required": [ "id", "productStreamId", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -33620,8 +38135,7 @@ "required": [ "id", "productStreamId", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -33758,8 +38272,7 @@ "id", "productId", "salesChannelId", - "visibility", - "createdAt" + "visibility" ], "properties": { "id": { @@ -33866,8 +38379,7 @@ "id", "productId", "salesChannelId", - "visibility", - "createdAt" + "visibility" ], "properties": { "id": { @@ -33918,14 +38430,6 @@ { "required": [ "id", - "active", - "priority", - "exclusive", - "useCodes", - "useIndividualCodes", - "useSetGroups", - "preventCombination", - "createdAt", "name" ], "properties": { @@ -34308,14 +38812,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "active", - "priority", - "exclusive", - "useCodes", - "useIndividualCodes", - "useSetGroups", - "preventCombination", - "createdAt", "name" ], "properties": { @@ -34502,9 +38998,7 @@ "promotionId", "scope", "type", - "value", - "considerAdvancedRules", - "createdAt" + "value" ], "properties": { "id": { @@ -34662,9 +39156,7 @@ "promotionId", "scope", "type", - "value", - "considerAdvancedRules", - "createdAt" + "value" ], "properties": { "id": { @@ -34743,8 +39235,7 @@ "id", "discountId", "currencyId", - "price", - "createdAt" + "price" ], "properties": { "id": { @@ -34847,8 +39338,7 @@ "id", "discountId", "currencyId", - "price", - "createdAt" + "price" ], "properties": { "id": { @@ -34924,8 +39414,7 @@ "required": [ "id", "promotionId", - "code", - "createdAt" + "code" ], "properties": { "id": { @@ -34996,8 +39485,7 @@ "required": [ "id", "promotionId", - "code", - "createdAt" + "code" ], "properties": { "id": { @@ -35125,8 +39613,7 @@ "id", "promotionId", "salesChannelId", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -35229,8 +39716,7 @@ "id", "promotionId", "salesChannelId", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -35280,8 +39766,7 @@ "promotionId", "packagerKey", "sorterKey", - "value", - "createdAt" + "value" ], "properties": { "id": { @@ -35389,8 +39874,7 @@ "promotionId", "packagerKey", "sorterKey", - "value", - "createdAt" + "value" ], "properties": { "id": { @@ -35470,9 +39954,6 @@ { "required": [ "id", - "displayType", - "sortingType", - "createdAt", "name" ], "properties": { @@ -35563,9 +40044,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "displayType", - "sortingType", - "createdAt", "name" ], "properties": { @@ -35630,7 +40108,6 @@ "required": [ "id", "groupId", - "createdAt", "name" ], "properties": { @@ -35838,7 +40315,6 @@ "required": [ "id", "groupId", - "createdAt", "name" ], "properties": { @@ -35917,8 +40393,7 @@ "required": [ "id", "name", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -36412,8 +40887,7 @@ "required": [ "id", "name", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -36555,8 +41029,7 @@ "required": [ "id", "type", - "ruleId", - "createdAt" + "ruleId" ], "properties": { "id": { @@ -36731,8 +41204,7 @@ "required": [ "id", "type", - "ruleId", - "createdAt" + "ruleId" ], "properties": { "id": { @@ -36838,7 +41310,6 @@ "countryId", "navigationCategoryId", "accessKey", - "createdAt", "name", "homeEnabled" ], @@ -38174,7 +42645,6 @@ "countryId", "navigationCategoryId", "accessKey", - "createdAt", "name", "homeEnabled" ], @@ -38559,8 +43029,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -38631,8 +43100,7 @@ "SalesChannelAnalytics": { "description": "Added since version: 6.2.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -38736,8 +43204,7 @@ "salesChannelId", "languageId", "currencyId", - "snippetSetId", - "createdAt" + "snippetSetId" ], "properties": { "id": { @@ -38779,42 +43246,6 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "guidedShoppingAppointmentGuideSalesChannelDomain": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/guidedShoppingAppointmentGuideSalesChannelDomain" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "9d35c5d56efd23115cc9ea665c63ad99" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "relationships": { "properties": { "salesChannel": { @@ -39009,8 +43440,7 @@ "salesChannelId", "languageId", "currencyId", - "snippetSetId", - "createdAt" + "snippetSetId" ], "properties": { "id": { @@ -39052,42 +43482,6 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "guidedShoppingAppointmentGuideSalesChannelDomain": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/guidedShoppingAppointmentGuideSalesChannelDomain" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "9d35c5d56efd23115cc9ea665c63ad99" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, @@ -39205,7 +43599,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -39298,7 +43691,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -39365,7 +43757,6 @@ "required": [ "id", "salutationKey", - "createdAt", "displayName", "letterName" ], @@ -39569,7 +43960,6 @@ "required": [ "id", "salutationKey", - "createdAt", "displayName", "letterName" ], @@ -39649,9 +44039,7 @@ "scheduledTaskClass", "runInterval", "defaultRunInterval", - "status", - "nextExecutionTime", - "createdAt" + "status" ], "properties": { "id": { @@ -39706,9 +44094,7 @@ "scheduledTaskClass", "runInterval", "defaultRunInterval", - "status", - "nextExecutionTime", - "createdAt" + "status" ], "properties": { "id": { @@ -39765,8 +44151,7 @@ "script", "hook", "name", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -39845,8 +44230,7 @@ "script", "hook", "name", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -39898,8 +44282,7 @@ "foreignKey", "routeName", "pathInfo", - "seoPathInfo", - "createdAt" + "seoPathInfo" ], "properties": { "id": { @@ -40033,8 +44416,7 @@ "foreignKey", "routeName", "pathInfo", - "seoPathInfo", - "createdAt" + "seoPathInfo" ], "properties": { "id": { @@ -40111,8 +44493,7 @@ "required": [ "id", "entityName", - "routeName", - "createdAt" + "routeName" ], "properties": { "id": { @@ -40192,8 +44573,7 @@ "required": [ "id", "entityName", - "routeName", - "createdAt" + "routeName" ], "properties": { "id": { @@ -40245,8 +44625,6 @@ "required": [ "id", "deliveryTimeId", - "taxType", - "createdAt", "name" ], "properties": { @@ -40623,8 +45001,6 @@ "required": [ "id", "deliveryTimeId", - "taxType", - "createdAt", "name" ], "properties": { @@ -40743,8 +45119,7 @@ { "required": [ "id", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -40776,7 +45151,10 @@ "format": "float" }, "currencyPrice": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "customFields": { "type": "object" @@ -40892,8 +45270,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -40925,7 +45302,10 @@ "format": "float" }, "currencyPrice": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "customFields": { "type": "object" @@ -40992,8 +45372,7 @@ "setId", "translationKey", "value", - "author", - "createdAt" + "author" ], "properties": { "id": { @@ -41072,8 +45451,7 @@ "setId", "translationKey", "value", - "author", - "createdAt" + "author" ], "properties": { "id": { @@ -41123,8 +45501,7 @@ "id", "name", "baseFile", - "iso", - "createdAt" + "iso" ], "properties": { "id": { @@ -41231,8 +45608,7 @@ "id", "name", "baseFile", - "iso", - "createdAt" + "iso" ], "properties": { "id": { @@ -41286,7 +45662,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -41428,7 +45803,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -41497,8 +45871,7 @@ "stateMachineId", "entityName", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -41680,8 +46053,7 @@ "stateMachineId", "entityName", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -41754,7 +46126,6 @@ "id", "technicalName", "stateMachineId", - "createdAt", "name" ], "properties": { @@ -42112,7 +46483,6 @@ "id", "technicalName", "stateMachineId", - "createdAt", "name" ], "properties": { @@ -42218,8 +46588,7 @@ "actionName", "stateMachineId", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -42358,8 +46727,7 @@ "actionName", "stateMachineId", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -42416,8 +46784,7 @@ "required": [ "id", "configurationKey", - "configurationValue", - "createdAt" + "configurationValue" ], "properties": { "id": { @@ -42493,8 +46860,7 @@ "required": [ "id", "configurationKey", - "configurationValue", - "createdAt" + "configurationValue" ], "properties": { "id": { @@ -42541,8 +46907,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -42855,8 +47220,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -42943,9 +47307,7 @@ "required": [ "id", "taxRate", - "name", - "position", - "createdAt" + "name" ], "properties": { "id": { @@ -43085,9 +47447,7 @@ "required": [ "id", "taxRate", - "name", - "position", - "createdAt" + "name" ], "properties": { "id": { @@ -43151,7 +47511,6 @@ "id", "identifier", "priority", - "createdAt", "name" ], "properties": { @@ -43273,7 +47632,6 @@ "id", "identifier", "priority", - "createdAt", "name" ], "properties": { @@ -43342,8 +47700,7 @@ "taxRuleTypeId", "countryId", "taxRate", - "taxId", - "createdAt" + "taxId" ], "properties": { "id": { @@ -43505,8 +47862,7 @@ "taxRuleTypeId", "countryId", "taxRate", - "taxId", - "createdAt" + "taxId" ], "properties": { "id": { @@ -43587,7 +47943,6 @@ "id", "technicalName", "position", - "createdAt", "typeName" ], "properties": { @@ -43666,7 +48021,6 @@ "id", "technicalName", "position", - "createdAt", "typeName" ], "properties": { @@ -43718,8 +48072,7 @@ "id", "name", "author", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -43918,8 +48271,7 @@ "id", "name", "author", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -44097,7 +48449,6 @@ { "required": [ "id", - "createdAt", "shortCode", "name" ], @@ -44173,7 +48524,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "shortCode", "name" ], @@ -44226,9 +48576,7 @@ "username", "firstName", "lastName", - "email", - "timeZone", - "createdAt" + "email" ], "properties": { "id": { @@ -44316,192 +48664,6 @@ } }, "type": "object" - }, - "guidedShoppingAppointmentGuideUser": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/guidedShoppingAppointmentGuideUser" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "d1927976a522fb34b836497d28ee7037" - } - } - } - } - }, - "type": "object" - }, - "createdPresentations": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdPresentations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation" - }, - "id": { - "type": "string", - "example": "d1e11035d87216918d95e78a7ac396da" - } - } - } - } - }, - "type": "object" - }, - "updatedPresentations": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedPresentations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation" - }, - "id": { - "type": "string", - "example": "49fb9c4fad69d4a3da998a936016c88d" - } - } - } - } - }, - "type": "object" - }, - "createdAppointments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdAppointments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "888e350c3c9a465bc4d7c8a80840b2aa" - } - } - } - } - }, - "type": "object" - }, - "updatedAppointments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedAppointments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "b64277a1e650794e2c57924c07825014" - } - } - } - } - }, - "type": "object" - }, - "createdLayouts": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdLayouts" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "example": "22b76a69d00feab60733ea096895a432" - } - } - } - } - }, - "type": "object" } }, "type": "object" @@ -44921,253 +49083,65 @@ "username", "firstName", "lastName", - "email", - "timeZone", - "createdAt" + "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" - }, - "localeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "username": { - "type": "string" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "title": { - "type": "string" - }, - "email": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - }, - "lastUpdatedPasswordAt": { - "type": "string", - "format": "date-time" - }, - "timeZone": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "avatarId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "createdNotifications": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdNotifications" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "notification" - }, - "id": { - "type": "string", - "example": "04f88ea12127fe03b65beffbc2c96954" - } - } - } - } - }, - "type": "object" - }, - "guidedShoppingAppointmentGuideUser": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/guidedShoppingAppointmentGuideUser" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "d1927976a522fb34b836497d28ee7037" - } - } - } - } - }, - "type": "object" - }, - "createdPresentations": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdPresentations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation" - }, - "id": { - "type": "string", - "example": "d1e11035d87216918d95e78a7ac396da" - } - } - } - } - }, - "type": "object" - }, - "updatedPresentations": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedPresentations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation" - }, - "id": { - "type": "string", - "example": "49fb9c4fad69d4a3da998a936016c88d" - } - } - } - } - }, - "type": "object" - }, - "createdAppointments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdAppointments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "888e350c3c9a465bc4d7c8a80840b2aa" - } - } - } - } - }, - "type": "object" - }, - "updatedAppointments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedAppointments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "b64277a1e650794e2c57924c07825014" - } - } - } - } - }, - "type": "object" - }, - "createdLayouts": { + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "username": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "title": { + "type": "string" + }, + "email": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + }, + "lastUpdatedPasswordAt": { + "type": "string", + "format": "date-time" + }, + "timeZone": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "avatarId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "createdNotifications": { "properties": { "links": { "type": "object", @@ -45175,7 +49149,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdLayouts" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdNotifications" } } }, @@ -45186,11 +49160,11 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "notification" }, "id": { "type": "string", - "example": "22b76a69d00feab60733ea096895a432" + "example": "04f88ea12127fe03b65beffbc2c96954" } } } @@ -45284,8 +49258,7 @@ "id", "userId", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -45364,8 +49337,7 @@ "id", "userId", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -45415,8 +49387,7 @@ "required": [ "id", "userId", - "key", - "createdAt" + "key" ], "properties": { "id": { @@ -45487,8 +49458,7 @@ "required": [ "id", "userId", - "key", - "createdAt" + "key" ], "properties": { "id": { @@ -45531,8 +49501,7 @@ "required": [ "id", "hash", - "userId", - "createdAt" + "userId" ], "properties": { "id": { @@ -45600,8 +49569,7 @@ "required": [ "id", "hash", - "userId", - "createdAt" + "userId" ], "properties": { "id": { @@ -45642,9 +49610,7 @@ "id", "name", "eventName", - "url", - "errorCount", - "createdAt" + "url" ], "properties": { "id": { @@ -45730,9 +49696,7 @@ "id", "name", "eventName", - "url", - "errorCount", - "createdAt" + "url" ], "properties": { "id": { @@ -45791,8 +49755,7 @@ "webhookName", "eventName", "deliveryStatus", - "url", - "createdAt" + "url" ], "properties": { "id": { @@ -45866,8 +49829,7 @@ "webhookName", "eventName", "deliveryStatus", - "url", - "createdAt" + "url" ], "properties": { "id": { @@ -45932,7 +49894,7 @@ }, "type": "object" }, - "flowBulderActionsResponse": { + "flowBuilderActionsResponse": { "type": "array", "items": { "type": "object", @@ -45958,130 +49920,6 @@ } } }, - "OAuthScopes": { - "description": "OAuth scopes that should be requested.", - "type": "string", - "enum": [ - "write", - "user-verified", - "admin", - "write user-verified", - "write admin", - "user-verified admin", - "write user-verified admin" - ] - }, - "OAuthGrant": { - "type": "object", - "properties": { - "grant_type": { - "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", - "type": "string" - } - }, - "required": [ - "grant_type" - ], - "discriminator": { - "propertyName": "grant_type", - "mapping": { - "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", - "password": "#/components/schemas/OAuthPasswordGrant", - "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" - } - } - }, - "OAuthClientCredentialsGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string" - }, - "client_secret": { - "description": "Password of the client that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "client_secret" - ] - } - ] - }, - "OAuthPasswordGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scopes": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "username": { - "description": "Username of the user that should be authenticated.", - "type": "string" - }, - "password": { - "description": "Password of the user that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "scopes", - "username", - "password" - ] - } - ] - }, - "OAuthRefreshTokenGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scopes": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "refresh_token": { - "description": "The refresh token that should be used to refresh the access token.", - "type": "string" - } - }, - "required": [ - "client_id", - "scopes", - "refresh_token" - ] - } - ] - }, "Criteria": { "type": "object", "description": "Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure)", @@ -46098,22 +49936,19 @@ "type": "array", "description": "List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)", "items": { - "type": "object", - "properties": { - "type": { - "type": "string" + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "field": { - "type": "string" + { + "$ref": "#/components/schemas/EqualsFilter" }, - "value": { - "type": "string" + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } - }, - "required": [ - "type", - "field", - "value" ] } }, @@ -46142,1403 +49977,940 @@ "type": "array", "description": "Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)", "items": { - "type": "object", - "properties": { - "type": { - "type": "string" + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "field": { - "type": "string" + { + "$ref": "#/components/schemas/EqualsFilter" }, - "value": { - "type": "string" + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } - }, - "required": [ - "type", - "field", - "value" ] } }, "associations": { - "type": "object", - "description": "Used to fetch associations which are not fetched by default." + "$ref": "#/components/schemas/Associations" }, "aggregations": { "type": "array", - "description": "Used to perform aggregations on the search result. For more information, see [Search Queries > Aggregations](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#aggregations)", - "items": { - "type": "object", - "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" - }, - "type": { - "description": "The type of aggregation", - "type": "string" - }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" - } - }, - "required": [ - "name", - "type", - "field" - ] - } - }, - "grouping": { - "type": "array", - "description": "Perform groupings over certain fields", - "items": { - "type": "string", - "description": "Name of a field" - } - }, - "fields": { - "type": "array", - "description": "Fields which should be returned in the search result.", "items": { - "type": "string", - "description": "Name of a field" - } - }, - "total-count-mode": { - "description": "Whether the total for the total number of hits should be determined for the search query. none = disabled total count, exact = calculate exact total amount (slow), next-pages = calculate only for next page (fast)", - "type": "string", - "default": "none", - "enum": [ - "none", - "exact", - "next-pages" - ] - } - } - }, - "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." - } + "$ref": "#/components/schemas/Aggregation" } - } - } - }, - "businessEventsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the event" - }, - "class": { - "type": "string", - "description": "Class name of the event" - }, - "data": { - "type": "object", - "description": "Available data of event" - }, - "aware": { - "type": "array", - "description": "Flow builder will base on awareness to show actions", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "description": "Extensions data of event", - "items": { - "type": "string" - } - } - } - } - }, - "DynamicPageOpenedPayload": { - "allOf": [ - { - "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" - } - ] - }, - "AttendeeInsights": { - "type": "object", - "description": "Attendee Insights", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Id of the attendee" - }, - "cartSum": { - "type": "number", - "description": "Sum of the cart net in base currency" - }, - "productCount": { - "type": "number", - "description": "Sum of all quantities in the cart which were added during the appointment" - } - }, - "example": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } - } - }, - "JoinAppointmentResponse": { - "type": "object", - "description": "Includes all data you will need to attend to a appointment.", - "properties": { - "mercureSubscriberTopics": { - "type": "array", - "items": { - "type": "string", - "description": "mercure topic" - }, - "description": "The topics to which the attendee/guide can subscribe for" - }, - "mercurePublisherTopic": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The topic to which the attendee/guide can send updates" - }, - "JWTMercureSubscriberToken": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The JWT mercure token to publish updates" - }, - "mercureHubPublicUrl": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The mercure hub url to connect for subscribing and updating" - }, - "JWTMercurePublisherToken": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The JWT mercure token to subscribe for updates" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The appointment id" - }, - "newContextToken": { - "type": "string", - "description": "The new context token" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The created Id for the attendee" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the current sales channel" - }, - "salesChannelName": { - "type": "string", - "description": "The name of the current sales channel" - }, - "appointmentName": { - "type": "string", - "description": "The name of the appointment" - }, - "presentationGuideMode": { - "type": "string", - "enum": [ - "self", - "guided" - ], - "description": "The type of the appointment" - }, - "isPreview": { - "type": "boolean", - "description": "To see if it's a preview appointment" - } - }, - "example": { - "mercureSubscriberTopics": [ - "gs-guide-actions-2d2c358f1ca04098aacf12873c2eed82", - "gs-presentation-state-for-client-2d2c358f1ca04098aacf12873c2eed82", - "gs-presentation-state-for-all-2d2c358f1ca04098aacf12873c2eed82" - ], - "mercurePublisherTopic": "gs-client-actions-2d2c358f1ca04098aacf12873c2eed82", - "JWTMercureSubscriberToken": "jwt token for subscribing to updates", - "mercureHubPublicUrl": "http://localhost:8081/.well-known/mercure", - "JWTMercurePublisherToken": "jwt token for publishing updates", - "id": "2d2c358f1ca04098aacf12873c2eed82", - "newContextToken": "new context token to call the other routes", - "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", - "salesChannelId": "4a791ec7f9ff46b2ad67ae2f562891d3", - "salesChannelName": "Storefront", - "appointmentName": "Test Appointment", - "presentationGuideMode": "guided", - "isPreview": false, - "apiAlias": "swag_guided_shopping_content_appointment_struct_appointment_join_struct" - } - }, - "AttendeeProductCollection": { - "type": "object", - "required": [ - "attendeeId", - "productId", - "productVersionId", - "alias" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "attendee": { - "$ref": "#/components/schemas/Attendee" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "product": { - "$ref": "#/components/schemas/Product" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "alias": { - "type": "string", - "enum": [ - "liked", - "disliked" - ] - } - } - }, - "StateForAll": { - "type": "object", - "properties": { - "currentGuideProductId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "lastActiveGuideSection": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "currentPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "currentSectionId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "currentSlideAlias": { - "type": "integer", - "default": 0 }, - "currentDynamicPage": { - "$ref": "#/components/schemas/DynamicPageOpenedPayload" + "grouping": { + "type": "array", + "description": "Perform groupings over certain fields", + "items": { + "type": "string", + "description": "Name of a field" + } }, - "started": { - "type": "boolean", - "default": false + "fields": { + "type": "array", + "description": "Fields which should be returned in the search result.", + "items": { + "type": "string", + "description": "Name of a field" + } }, - "running": { - "type": "boolean", - "default": false + "total-count-mode": { + "description": "Whether the total for the total number of hits should be determined for the search query. none = disabled total count, exact = calculate exact total amount (slow), next-pages = calculate only for next page (fast)", + "type": "string", + "default": "none", + "enum": [ + "none", + "exact", + "next-pages" + ] }, - "ended": { - "type": "boolean", - "default": false + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" + } }, - "startedAt": { - "anyOf": [ - { + "includes": { + "$ref": "#/components/schemas/Includes" + } + } + }, + "Includes": { + "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Filters": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "SimpleFilter": { + "anyOf": [ + { + "type": "object", + "properties": { + "type": { "type": "string", - "format": "date-time" + "enum": [ + "contains", + "equalsAny", + "prefix", + "suffix" + ] }, - { - "type": "null" - } - ] - }, - "endedAt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" + "field": { + "type": "string" }, - { - "type": "null" + "value": { + "type": "string" } + }, + "required": [ + "type", + "field", + "value" ] }, - "accessibleFrom": { - "anyOf": [ - { + { + "type": "object", + "properties": { + "type": { "type": "string", - "format": "date-time" + "enum": [ + "equalsAny", + "equalsAll" + ] }, - { - "type": "null" - } - ] - }, - "accessibleTo": { - "anyOf": [ - { - "type": "string", - "format": "date-time" + "field": { + "type": "string" }, - { - "type": "null" + "value": { + "type": "array", + "items": { + "type": "string" + } } + }, + "required": [ + "type", + "field", + "value" ] - }, - "appointmentMode": { + } + ] + }, + "EqualsFilter": { + "type": "object", + "properties": { + "type": { "type": "string", "enum": [ - "guided", - "self" + "equals" ] }, - "videoAudioSettings": { - "type": "string", - "enum": [ - "both", - "none", - "audio-only" - ], - "default": "none" - }, - "videoRoomUrl": { - "type": "string", - "default": "" + "field": { + "type": "string" }, - "attendeeRestrictionType": { - "anyOf": [ + "value": { + "oneOf": [ { - "type": "string", - "enum": [ - "open", - "customer", - "rules" - ] + "type": "string" }, { - "type": "null" - } - ] - }, - "productDetailDefaultPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "number" }, { - "type": "null" - } - ] - }, - "quickviewPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "boolean" }, { "type": "null" } ] - }, - "productListingDefaultPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } + } + }, + "required": [ + "type", + "field", + "value" + ] + }, + "MultiNotFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "multi", + "not" ] }, - "allowUserActionsForGuide": { - "type": "boolean", - "default": false - }, - "broadcastMode": { - "type": "boolean", - "default": false + "operator": { + "type": "string", + "enum": [ + "and", + "or", + "nor", + "nand" + ] }, - "extensions": { - "type": "array", - "default": [] + "queries": { + "$ref": "#/components/schemas/Filters" } - } + }, + "required": [ + "type", + "queries" + ] }, - "GetCartInsightsResponse": { + "RangeFilter": { "type": "object", - "description": "Returns aggregations for the current carts within the appointment.", "properties": { - "cartSum": { - "type": "number", - "description": "Sum of all products from all attenddees which were added to the cart during the appointment" - }, - "productCount": { - "type": "number", - "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" - }, - "currencyId": { + "type": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the shown currency" + "enum": [ + "range" + ] }, - "currencySymbol": { - "type": "string", - "description": "The currency symbol from the shown currency" + "field": { + "type": "string" }, - "topProducts": { + "parameters": { "type": "object", - "required": [ - "byQuantity", - "byRevenue" - ], "properties": { - "byQuantity": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "object", - "properties": { - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the product" - }, - "value": { - "type": "number", - "description": "The quantity in carts of this product" - } + "gte": { + "anyOf": [ + { + "type": "number" }, - "required": [ - "productId", - "value" - ] - } + { + "type": "string" + } + ] }, - "byRevenue": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "object", - "properties": { - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the product" - }, - "value": { - "type": "number", - "description": "The net revenue in the shown currency in carts of this product" - } + "gt": { + "anyOf": [ + { + "type": "number" }, - "required": [ - "productId", - "value" - ] - } - } - } - } - }, - "example": { - "extensions": [], - "cartSum": 6770.53, - "productCount": 3, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$", - "topProducts": { - "byQuantity": [ - { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1 - }, - { - "productId": "fee3ca762be94bb49b692e359d529563", - "value": 1 - }, - { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 1 - } - ], - "byRevenue": [ - { - "productId": "fee3ca762be94bb49b692e359d529563", - "value": 5333.03 + { + "type": "string" + } + ] }, - { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1152.62 + "lte": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] }, - { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 284.88 + "lt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] } - ] + } } - } + }, + "required": [ + "type", + "field", + "parameters" + ] }, - "Presentation": { + "Sort": { "type": "object", - "required": [ - "name" - ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "field": { + "type": "string" }, - "versionId": { + "order": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "ASC", + "DESC" + ] }, - "active": { + "naturalSorting": { "type": "boolean" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { + "type": { "type": "string" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdBy": { - "$ref": "#/components/schemas/User" - }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedBy": { - "$ref": "#/components/schemas/User" - }, - "translations": { - "type": "array", - "items": { - "type": "object" - } - }, - "appointment": { - "$ref": "#/components/schemas/Appointment" - }, - "cmsPages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PresentationCmsPage" - } - }, - "translated": { - "type": "object" } - } + }, + "required": [ + "field", + "order" + ] }, - "GuidePresentationStateResponse": { + "Associations": { "type": "object", - "properties": { - "stateForAll": { - "$ref": "#/components/schemas/StateForAll" - }, - "stateForClients": { - "$ref": "#/components/schemas/StateForGuides" - } - }, - "example": { - "extensions": [], - "stateForAll": { - "currentGuideProductId": null, - "lastActiveGuideSection": null, - "currentPageId": null, - "currentSectionId": null, - "currentSlideAlias": 0, - "currentDynamicPage": null, - "started": false, - "running": false, - "ended": false, - "startedAt": null, - "endedAt": null, - "accessibleFrom": { - "date": "2023-08-04 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "accessibleTo": { - "date": "2023-08-05 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "appointmentMode": "guided", - "videoAudioSettings": "both", - "videoRoomUrl": "", - "attendeeRestrictionType": "open", - "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", - "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", - "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", - "allowUserActionsForGuide": true, - "broadcastMode": false, - "extensions": [] - }, - "stateForGuides": { - "clients": [], - "inactiveClients": { - "2b4066cd37a341088e32a81e04a56817": { - "attendeeId": "2b4066cd37a341088e32a81e04a56817", - "attendeeName": "Attendee 1", - "videoUserId": null, - "guideCartPermissionsGranted": false, - "hasJoined": false - }, - "302108ad602b4ac687f5247aae5d0297": { - "attendeeId": "302108ad602b4ac687f5247aae5d0297", - "attendeeName": null, - "videoUserId": null, - "guideCartPermissionsGranted": false, - "hasJoined": true - }, - "5a3b4e84acab47119b8a6bceb79e732e": { - "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", - "attendeeName": "Test attende name", - "videoUserId": null, - "guideCartPermissionsGranted": true, - "hasJoined": true - }, - "b6358241e4ad4a4e99d0f729d21d63be": { - "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", - "attendeeName": null, - "videoUserId": null, - "guideCartPermissionsGranted": false, - "hasJoined": true - }, - "f1bb9374308d4e088c29d10a2fc8cc07": { - "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", - "attendeeName": null, - "videoUserId": null, - "guideCartPermissionsGranted": false, - "hasJoined": false - } - }, - "guides": { - "1850bbdc12dc44aba95bc78b16c3643c": { - "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", - "attendeeName": " admin", - "videoUserId": null, - "guideCartPermissionsGranted": false, - "hasJoined": true - } - }, - "videoGuideToken": null, - "quickViewState": [], - "extensions": [] - } + "additionalProperties": { + "$ref": "#/components/schemas/Criteria" } }, - "PresentationCmsPage": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The presentation cms page id" - }, - "title": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The title of presentation cms page" - }, - "presentationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The presentation using this presentation cms page" - }, - "guidedShoppingPresentationVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The CMS page id the presentation using" - }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The CMS page version id the presentation using" + "Aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" }, - "productId": { - "anyOf": [ + { + "title": "AggregationEntity", + "allOf": [ { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "$ref": "#/components/schemas/AggregationEntity" }, { - "type": "null" + "$ref": "#/components/schemas/SubAggregations" } - ], - "description": "The product id is assigned to presentation if it's product detail" + ] }, - "productStreamId": { - "anyOf": [ + { + "title": "AggregationFilter", + "allOf": [ { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "$ref": "#/components/schemas/AggregationFilter" }, { - "type": "null" + "$ref": "#/components/schemas/SubAggregations" } - ], - "description": "The product stream id is assigned to presentation if it's product listing" + ] }, - "pickedProductIds": { - "anyOf": [ + { + "title": "AggregationTerms", + "allOf": [ { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Product id" - } + "$ref": "#/components/schemas/AggregationTerms" }, { - "type": "null" + "$ref": "#/components/schemas/SubAggregations" } - ], - "description": "The product id is assigned to presentation if it's product listing or instant listing" - }, - "position": { - "type": "integer", - "description": "The position of slide" - }, - "isInstantListing": { - "type": "boolean", - "description": "True if this slide is an instant listing" - }, - "createdAt": { - "type": "string", - "format": "date-time" + ] }, - "updatedAt": { - "anyOf": [ + { + "title": "AggregationHistogram", + "allOf": [ { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/AggregationHistogram" }, { - "type": "null" + "$ref": "#/components/schemas/SubAggregations" } ] }, - "customFields": { - "anyOf": [ + { + "title": "AggregationRange", + "allOf": [ { - "type": "object" + "$ref": "#/components/schemas/AggregationRange" }, { - "type": "null" - } - ] - }, - "translated": { - "type": "object", - "properties": { - "title": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "$ref": "#/components/schemas/SubAggregations" } - } - } - } - }, - "Attendee": { - "type": "object", - "required": [ - "appointmentId", - "type" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appointmentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appointment": { - "$ref": "#/components/schemas/Appointment" - }, - "type": { - "type": "string", - "enum": [ - "CLIENT", - "GUIDE" ] - }, - "attendeeName": { - "type": "string" - }, - "attendeeEmail": { - "type": "string" - }, - "videoUserId": { - "type": "string" - }, - "guideCartPermissionsGranted": { - "type": "boolean" - }, - "attendeeSubmittedAt": { - "type": "string", - "format": "date-timme" - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "user": { - "$ref": "#/components/schemas/User" - }, - "invitationStatus": { - "type": "string" - }, - "joinedAt": { - "type": "string", - "format": "date-timme" - }, - "lastActive": { - "type": "string", - "format": "date-timme" - }, - "interaction": { - "$ref": "#/components/schemas/Interaction" - }, - "productCollections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttendeeProductCollection" - } } - } + ] }, - "Interaction": { + "SubAggregations": { "type": "object", - "required": [ - "name", - "triggeredAt", - "attendeeId" - ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "expiresAt": { - "type": "string", - "format": "date-time" - }, - "triggeredAt": { - "type": "string", - "format": "date-time" - }, - "payload": { - "type": "string" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "attendee": { - "$ref": "#/components/schemas/Attendee" + "aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" + }, + { + "$ref": "#/components/schemas/AggregationEntity" + }, + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/AggregationTerms" + }, + { + "$ref": "#/components/schemas/AggregationHistogram" + }, + { + "$ref": "#/components/schemas/AggregationRange" + } + ] } } }, - "AbstractDynamicPageOpenedPayload": { + "AggregationEntity": { + "title": "AggregationEntity", "type": "object", - "required": [ - "type" - ], "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" + }, "type": { + "description": "The type of aggregation", "type": "string", - "description": "The type of the current dynamic page" + "enum": [ + "entity" + ] }, - "opened": { - "type": "boolean", - "default": true + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "definition": { + "description": "The entity definition e.g \"product_manufacturer\".", + "type": "string" } - } + }, + "required": [ + "name", + "type", + "field", + "definition" + ] }, - "VideoChatCreateStruct": { + "AggregationFilter": { + "title": "AggregationFilter", "type": "object", - "description": "Includes all data you will need to attend to a appointment.", "properties": { - "roomUrl": { - "type": "string", - "description": "Url of the video room in daily" - }, - "roomName": { - "type": "string", - "description": "Name of the video room in daily" - }, - "userToken": { - "type": "string", - "description": "Token for the end users to connect to the daily room" + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "ownerToken": { + "type": { + "description": "The type of aggregation", "type": "string", - "description": "Token for the room owner (guide) to connect to the daily room" + "enum": [ + "filter" + ] }, - "startAsBroadcast": { - "type": "boolean", - "default": false + "filter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Filters" + } } }, - "example": { - "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", - "userToken": "dummy user token", - "ownerToken": "dummy owner token", - "roomName": "rSq20mrgwsj4eIXo1u95", - "startAsBroadcast": false, - "extensions": [] - } + "required": [ + "name", + "type", + "filter" + ] }, - "GetAttendeeInsightsResponse": { + "AggregationTerms": { + "title": "AggregationTerms", "type": "object", - "description": "Returns aggregations for the current attendees within the appointment.", "properties": { - "attendees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttendeeInsights" - } + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "currencyId": { + "type": { + "description": "The type of aggregation", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "terms" + ] }, - "currencySymbol": { + "field": { + "description": "The field you want to aggregate over.", "type": "string" - } - }, - "example": { - "extensions": [], - "attendees": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } }, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$" - } - }, - "GetListBodyRequest": { - "type": "object", - "properties": { "limit": { - "type": "integer", - "description": "Max amount of resources to be returned in a page" + "description": "The number of terms to return", + "type": "number" }, - "page": { - "type": "integer", - "description": "The page to be returned" + "sort": { + "type": "array", + "description": "Sorting the aggregation result.", + "items": { + "$ref": "#/components/schemas/Sort" + } } - } - }, - "Appointment": { - "type": "object", + }, "required": [ "name", - "guideUserId", - "salesChannelDomainId", - "presentationPath" - ], + "type", + "field" + ] + }, + "AggregationHistogram": { + "title": "AggregationHistogram", + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "name": { + "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, - "presentationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "presentation": { - "$ref": "#/components/schemas/Presentation" - }, - "active": { - "type": "boolean" - }, - "isPreview": { - "type": "boolean" - }, - "default": { - "type": "boolean" - }, - "guideUserId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "guideUser": { - "$ref": "#/components/schemas/User" - }, - "mode": { + "type": { + "description": "The type of aggregation", "type": "string", "enum": [ - "guide", - "self" + "histogram" ] }, - "salesChannelDomainId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "interval": { + "description": "The interval of the histogram", + "type": "number" + }, + "format": { + "description": "The format of the histogram", + "type": "string" }, - "presentationPath": { + "timeZone": { + "description": "The timezone of the histogram", + "type": "string" + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "AggregationRange": { + "title": "AggregationRange", + "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, - "attendeeRestrictionType": { + "type": { + "description": "The type of aggregation", "type": "string", "enum": [ - "open", - "customer", - "rules" + "range" ] }, - "accessibleFrom": { - "type": "string", - "format": "date-time" - }, - "accessibleTo": { - "type": "string", - "format": "date-time" - }, - "attendeeRuleIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "field": { + "description": "The field you want to aggregate over.", + "type": "string" }, - "attendees": { + "ranges": { + "description": "The ranges of the aggregation", "type": "array", "items": { - "$ref": "#/components/schemas/Attendee" + "type": "object", + "anyOf": [ + { + "type": "object", + "title": "From and to", + "properties": { + "from": { + "type": "number", + "description": "The lower bound of the range" + }, + "to": { + "type": "number", + "description": "The upper bound of the range" + } + }, + "required": [ + "from", + "to" + ] + }, + { + "type": "object", + "title": "From only", + "properties": { + "from": { + "type": "string", + "description": "The lower bound of the range" + } + }, + "required": [ + "from" + ] + }, + { + "type": "object", + "title": "To only", + "properties": { + "to": { + "type": "string", + "description": "The upper bound of the range" + } + }, + "required": [ + "to" + ] + } + ] } - }, - "message": { + } + }, + "required": [ + "name", + "type", + "field", + "ranges" + ] + }, + "AggregationMetrics": { + "type": "object", + "properties": { + "name": { "type": "string" }, - "videoAudioSettings": { + "type": { "type": "string", "enum": [ - "none", - "both", - "audio_only" + "avg", + "count", + "max", + "min", + "stats", + "sum" ] }, - "videoChat": { - "$ref": "#/components/schemas/VideoChat" - }, - "startedAt": { + "field": { + "type": "string" + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "endedAt": { - "type": "string", - "format": "date-time" + "gross": { + "description": "", + "type": "number" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "net": { + "description": "", + "type": "number" }, - "createdBy": { - "$ref": "#/components/schemas/User" + "linked": { + "description": "", + "type": "boolean" }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" + ] }, - "updatedBy": { - "$ref": "#/components/schemas/User" + "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" + ] }, - "WidgetProductListing": { + "infoConfigResponse": { "type": "object", - "description": "Includes all data you will need to attend to a appointment.", "properties": { - "extensions": { - "type": "array", - "description": "List of extensions", - "default": [] + "version": { + "type": "string", + "description": "The Shopware version." }, - "products": { - "type": "array", - "description": "List of last seen products", - "items": { - "$ref": "#/components/schemas/Product" - } + "versionRevision": { + "type": "string", + "description": "The Shopware version revision." }, - "total": { - "type": "integer", - "description": "The total number of products" + "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" + } + } + } }, - "page": { - "type": "integer", - "description": "The current page" + "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." + } + } + } + } }, - "limit": { - "type": "integer", - "description": "The number of products per page" + "settings": { + "type": "object", + "properties": { + "enableUrlFeature": { + "type": "boolean", + "description": "State of the `urlFeature` setting." + } + } } } }, - "StateForGuides": { - "type": "object", - "properties": { - "clients": { - "type": "array", - "items": { - "type": "string" + "businessEventsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the event" }, - "default": [] - }, - "inactiveClients": { - "type": "array", - "items": { - "type": "string" + "class": { + "type": "string", + "description": "Class name of the event" }, - "default": [] - }, - "guides": { - "type": "array", - "items": { - "type": "string" + "data": { + "type": "object", + "description": "Available data of event" }, - "default": [] - }, - "videoGuideToken": { - "anyOf": [ - { + "aware": { + "type": "array", + "description": "Flow builder will base on awareness to show actions", + "items": { "type": "string" - }, - { - "type": "null" } - ] - }, - "quickViewState": { - "type": "array", - "items": { - "type": "string" }, - "default": [] - }, - "extensions": { - "type": "array", - "default": [] + "extensions": { + "type": "array", + "description": "Extensions data of event", + "items": { + "type": "string" + } + } } } }, - "VideoChat": { + "OAuthScopes": { + "description": "OAuth scopes that should be requested.", + "type": "string", + "enum": [ + "write", + "user-verified", + "admin", + "write user-verified", + "write admin", + "user-verified admin", + "write user-verified admin" + ] + }, + "OAuthGrant": { "type": "object", - "required": [ - "appointmentId" - ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appointmentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appointment": { - "$ref": "#/components/schemas/Appointment" - }, - "ownerToken": { + "grant_type": { + "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", "type": "string" + } + }, + "required": [ + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } + } + }, + "OAuthClientCredentialsGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" }, - "userToken": { - "type": "string" + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string" + }, + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret" + ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" }, - "url": { - "type": "string" + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scopes": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" + }, + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "scopes", + "username", + "password" + ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" }, - "startAsBroadcast": { - "type": "boolean" + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scopes": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" + } + }, + "required": [ + "client_id", + "scopes", + "refresh_token" + ] } - } + ] } }, "responses": { @@ -47901,7 +51273,7 @@ "description": "Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "externalDocs": { "description": "Find out more", - "url": "https://github.com/shopware/platform/blob/trunk/adr/2023-05-10-experimental-features.md" + "url": "https://github.com/shopware/shopware/blob/trunk/adr/2023-05-10-experimental-features.md" } }, { @@ -48052,34 +51424,6 @@ "name": "Flow Template", "description": "The endpoint for operations on Flow Template" }, - { - "name": "Guided Shopping Appointment", - "description": "The endpoint for operations on Guided Shopping Appointment" - }, - { - "name": "Guided Shopping Appointment Attendee", - "description": "The endpoint for operations on Guided Shopping Appointment Attendee" - }, - { - "name": "Guided Shopping Appointment Video Chat", - "description": "The endpoint for operations on Guided Shopping Appointment Video Chat" - }, - { - "name": "Guided Shopping Attendee Product Collection", - "description": "The endpoint for operations on Guided Shopping Attendee Product Collection" - }, - { - "name": "Guided Shopping Interaction", - "description": "The endpoint for operations on Guided Shopping Interaction" - }, - { - "name": "Guided Shopping Presentation", - "description": "The endpoint for operations on Guided Shopping Presentation" - }, - { - "name": "Guided Shopping Presentation Cms Page", - "description": "The endpoint for operations on Guided Shopping Presentation Cms Page" - }, { "name": "Import Export File", "description": "The endpoint for operations on Import Export File" diff --git a/SwagGuidedShopping-adminapi.summary.json b/SwagGuidedShopping-adminapi.summary.json index 8513b71..4d06f2e 100644 --- a/SwagGuidedShopping-adminapi.summary.json +++ b/SwagGuidedShopping-adminapi.summary.json @@ -1,46 +1,156 @@ { "paths": [ - "/_action/guided-shopping/appointment/attendee/{attendeeId}/sw-context-token", - "/_action/guided-shopping/appointment/{appointmentId}/end", - "/_action/guided-shopping/appointment/{appointmentId}/instant-listing", - "/_action/guided-shopping/appointment/{appointmentId}/join-as-guide", - "/_action/guided-shopping/appointment/{appointmentId}/presentation/state", - "/_action/guided-shopping/appointment/{appointmentId}/start", - "/_action/guided-shopping/appointment/{appointmentId}/video-room", - "/_action/guided-shopping/appointment/{appointmentId}/widgets/attendee-insights", - "/_action/guided-shopping/appointment/{appointmentId}/widgets/cart-insights", - "/_action/guided-shopping/appointment/{appointmentId}/widgets/cart-statistics", - "/_action/guided-shopping/appointment/{appointmentId}/widgets/last-seen", - "/_action/guided-shopping/appointment/{appointmentId}/widgets/wishlist", - "/guided-shopping-appointment", - "/guided-shopping-appointment-attendee", - "/guided-shopping-appointment-attendee/{id}", - "/guided-shopping-appointment-video-chat", - "/guided-shopping-appointment-video-chat/{id}", - "/guided-shopping-appointment/{appointmentId}", - "/guided-shopping-appointment/{id}", - "/guided-shopping-attendee-product-collection", - "/guided-shopping-attendee-product-collection/{id}", - "/guided-shopping-interaction", - "/guided-shopping-interaction/{id}", - "/guided-shopping-presentation", - "/guided-shopping-presentation-cms-page", - "/guided-shopping-presentation-cms-page/{id}", - "/guided-shopping-presentation/{id}", - "/guided-shopping-presentation/{presentationId}", - "/search/guided-shopping-appointment", - "/search/guided-shopping-appointment-attendee", - "/search/guided-shopping-appointment-video-chat", - "/search/guided-shopping-attendee-product-collection", - "/search/guided-shopping-interaction", - "/search/guided-shopping-presentation", - "/search/guided-shopping-presentation-cms-page" + "/_action/cache-delayed", + "/_info/routes", + "/_info/system-health-check", + "/_proxy/generate-imitate-customer-token", + "/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" ], "schemas": [ - "AbstractDynamicPageOpenedPayload", "AclRole", "AclRoleJsonApi", "AclUserRole", + "Aggregation", + "AggregationEntity", + "AggregationFilter", + "AggregationHistogram", + "AggregationMetrics", + "AggregationRange", + "AggregationTerms", "App", "AppActionButton", "AppActionButtonJsonApi", @@ -61,10 +171,7 @@ "AppShippingMethodJsonApi", "AppTemplate", "AppTemplateJsonApi", - "Appointment", - "Attendee", - "AttendeeInsights", - "AttendeeProductCollection", + "Associations", "Category", "CategoryJsonApi", "CategoryTag", @@ -117,42 +224,24 @@ "DocumentJsonApi", "DocumentType", "DocumentTypeJsonApi", - "DynamicPageOpenedPayload", + "EqualsFilter", + "Filters", "Flow", "FlowJsonApi", "FlowSequence", "FlowSequenceJsonApi", "FlowTemplate", "FlowTemplateJsonApi", - "GetAttendeeInsightsResponse", - "GetCartInsightsResponse", - "GetListBodyRequest", - "GuidePresentationStateResponse", - "GuidedShoppingAppointment", - "GuidedShoppingAppointmentAttendee", - "GuidedShoppingAppointmentAttendeeJsonApi", - "GuidedShoppingAppointmentJsonApi", - "GuidedShoppingAppointmentVideoChat", - "GuidedShoppingAppointmentVideoChatJsonApi", - "GuidedShoppingAttendeeProductCollection", - "GuidedShoppingAttendeeProductCollectionJsonApi", - "GuidedShoppingInteraction", - "GuidedShoppingInteractionJsonApi", - "GuidedShoppingPresentation", - "GuidedShoppingPresentationCmsPage", - "GuidedShoppingPresentationCmsPageJsonApi", - "GuidedShoppingPresentationJsonApi", "ImportExportFile", "ImportExportFileJsonApi", "ImportExportLog", "ImportExportLogJsonApi", "ImportExportProfile", "ImportExportProfileJsonApi", + "Includes", "Integration", "IntegrationJsonApi", "IntegrationRole", - "Interaction", - "JoinAppointmentResponse", "LandingPage", "LandingPageJsonApi", "LandingPageSalesChannel", @@ -186,6 +275,7 @@ "MediaThumbnailJsonApi", "MediaThumbnailSize", "MediaThumbnailSizeJsonApi", + "MultiNotFilter", "NewsletterRecipient", "NewsletterRecipientJsonApi", "NewsletterRecipientTag", @@ -231,8 +321,7 @@ "PaymentMethodJsonApi", "Plugin", "PluginJsonApi", - "Presentation", - "PresentationCmsPage", + "Price", "Product", "ProductCategory", "ProductCategoryTree", @@ -300,6 +389,7 @@ "PropertyGroupJsonApi", "PropertyGroupOption", "PropertyGroupOptionJsonApi", + "RangeFilter", "Rule", "RuleCondition", "RuleConditionJsonApi", @@ -333,12 +423,12 @@ "ShippingMethodPrice", "ShippingMethodPriceJsonApi", "ShippingMethodTag", + "SimpleFilter", "Snippet", "SnippetJsonApi", "SnippetSet", "SnippetSetJsonApi", - "StateForAll", - "StateForGuides", + "Sort", "StateMachine", "StateMachineHistory", "StateMachineHistoryJsonApi", @@ -347,6 +437,7 @@ "StateMachineStateJsonApi", "StateMachineTransition", "StateMachineTransitionJsonApi", + "SubAggregations", "SystemConfig", "SystemConfigJsonApi", "Tag", @@ -374,19 +465,16 @@ "UserJsonApi", "UserRecovery", "UserRecoveryJsonApi", - "VideoChat", - "VideoChatCreateStruct", "Webhook", "WebhookEventLog", "WebhookEventLogJsonApi", "WebhookJsonApi", - "WidgetProductListing", "attributes", "businessEventsResponse", "data", "error", "failure", - "flowBulderActionsResponse", + "flowBuilderActionsResponse", "info", "infoConfigResponse", "jsonapi",