From 7ced4ece44be1a0bd0c35ecf63661e1375184eb8 Mon Sep 17 00:00:00 2001 From: shopwareBot Date: Fri, 5 Jun 2026 11:08:08 +0000 Subject: [PATCH] [create-pull-request] automated change --- SwagDigitalSalesRooms-adminapi.json | 19083 ++++++++---------- SwagDigitalSalesRooms-adminapi.summary.json | 18 - 2 files changed, 8350 insertions(+), 10751 deletions(-) diff --git a/SwagDigitalSalesRooms-adminapi.json b/SwagDigitalSalesRooms-adminapi.json index 69122a5..b4d64e4 100644 --- a/SwagDigitalSalesRooms-adminapi.json +++ b/SwagDigitalSalesRooms-adminapi.json @@ -15,14 +15,14 @@ } ], "paths": { - "/app-mcp-prompt": { + "/dsr-appointment": { "get": { "tags": [ - "App Mcp Prompt" + "Dsr Appointment" ], - "summary": "List with basic information of App Mcp Prompt resources.", - "description": "Available since: 6.7.0.0", - "operationId": "getAppMcpPromptList", + "summary": "List with basic information of Dsr Appointment resources.", + "description": "", + "operationId": "getDsrAppointmentList", "parameters": [ { "name": "limit", @@ -51,7 +51,7 @@ ], "responses": { "200": { - "description": "List of App Mcp Prompt resources.", + "description": "List of Dsr Appointment resources.", "content": { "application/vnd.api+json": { "schema": { @@ -70,7 +70,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } ] @@ -84,16 +84,16 @@ "type": "object", "properties": { "first": { - "example": "/app-mcp-prompt?limit=25" + "example": "/dsr-appointment?limit=25" }, "last": { - "example": "/app-mcp-prompt?limit=25&page=11" + "example": "/dsr-appointment?limit=25&page=11" }, "next": { - "example": "/app-mcp-prompt?limit=25&page=4" + "example": "/dsr-appointment?limit=25&page=4" }, "prev": { - "example": "/app-mcp-prompt?limit=25&page=2" + "example": "/dsr-appointment?limit=25&page=2" } } } @@ -114,7 +114,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -129,11 +129,11 @@ }, "post": { "tags": [ - "App Mcp Prompt" + "Dsr Appointment" ], - "summary": "Create a new App Mcp Prompt resources.", - "description": "Available since: 6.7.0.0", - "operationId": "createAppMcpPrompt", + "summary": "Create a new Dsr Appointment resources.", + "description": "", + "operationId": "createDsrAppointment", "parameters": [ { "name": "_response", @@ -152,14 +152,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } }, "responses": { "200": { - "description": "Detail of AppMcpPrompt", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -171,7 +171,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -186,7 +186,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -202,14 +202,14 @@ } } }, - "/search/app-mcp-prompt": { + "/search/dsr-appointment": { "post": { "tags": [ - "App Mcp Prompt" + "Dsr Appointment" ], - "summary": "Search for the App Mcp Prompt resources.", - "description": "Available since: 6.7.0.0", - "operationId": "searchAppMcpPrompt", + "summary": "Search for the Dsr Appointment resources.", + "description": "", + "operationId": "searchDsrAppointment", "parameters": [ { "name": "sw-include-search-info", @@ -237,7 +237,7 @@ }, "responses": { "200": { - "description": "List of AppMcpPrompt", + "description": "List of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -251,7 +251,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -269,7 +269,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -286,19 +286,19 @@ } } }, - "/app-mcp-prompt/{id}": { + "/dsr-appointment/{id}": { "get": { "tags": [ - "App Mcp Prompt" + "Dsr Appointment" ], - "summary": "Detailed information about a App Mcp Prompt resource.", - "description": "Available since: 6.7.0.0", - "operationId": "getAppMcpPrompt", + "summary": "Detailed information about a Dsr Appointment resource.", + "description": "", + "operationId": "getDsrAppointment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_prompt", + "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", @@ -308,7 +308,7 @@ ], "responses": { "200": { - "description": "Detail of AppMcpPrompt", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -320,7 +320,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -335,7 +335,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -352,16 +352,16 @@ }, "delete": { "tags": [ - "App Mcp Prompt" + "Dsr Appointment" ], - "summary": "Delete a App Mcp Prompt resource.", - "description": "Available since: 6.7.0.0", - "operationId": "deleteAppMcpPrompt", + "summary": "Delete a Dsr Appointment resource.", + "description": "", + "operationId": "deleteDsrAppointment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_prompt", + "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", @@ -392,16 +392,16 @@ }, "patch": { "tags": [ - "App Mcp Prompt" + "Dsr Appointment" ], - "summary": "Partially update information about a App Mcp Prompt resource.", - "description": "Available since: 6.7.0.0", - "operationId": "updateAppMcpPrompt", + "summary": "Partially update information about a Dsr Appointment resource.", + "description": "", + "operationId": "updateDsrAppointment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_prompt", + "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", @@ -419,18 +419,18 @@ } ], "requestBody": { - "description": "Partially update information about a App Mcp Prompt resource.", + "description": "Partially update information about a Dsr Appointment resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } }, "responses": { "200": { - "description": "Detail of AppMcpPrompt", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -442,7 +442,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -457,7 +457,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -476,14 +476,14 @@ } } }, - "/aggregate/app-mcp-prompt": { + "/aggregate/dsr-appointment": { "post": { "tags": [ - "App Mcp Prompt" + "Dsr Appointment" ], - "summary": "Aggregate for the App Mcp Prompt resources.", - "description": "Available since: 6.7.0.0", - "operationId": "aggregateAppMcpPrompt", + "summary": "Aggregate for the Dsr Appointment resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrAppointment", "requestBody": { "required": true, "content": { @@ -507,7 +507,7 @@ }, "responses": { "200": { - "description": "List of AppMcpPrompt", + "description": "List of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -521,7 +521,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -539,7 +539,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpPrompt" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -556,14 +556,14 @@ } } }, - "/app-mcp-resource": { + "/dsr-appointment-attendee": { "get": { "tags": [ - "App Mcp Resource" + "Dsr Appointment Attendee" ], - "summary": "List with basic information of App Mcp Resource resources.", - "description": "Available since: 6.7.0.0", - "operationId": "getAppMcpResourceList", + "summary": "List with basic information of Dsr Appointment Attendee resources.", + "description": "", + "operationId": "getDsrAppointmentAttendeeList", "parameters": [ { "name": "limit", @@ -592,7 +592,7 @@ ], "responses": { "200": { - "description": "List of App Mcp Resource resources.", + "description": "List of Dsr Appointment Attendee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -611,7 +611,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } ] @@ -625,16 +625,16 @@ "type": "object", "properties": { "first": { - "example": "/app-mcp-resource?limit=25" + "example": "/dsr-appointment-attendee?limit=25" }, "last": { - "example": "/app-mcp-resource?limit=25&page=11" + "example": "/dsr-appointment-attendee?limit=25&page=11" }, "next": { - "example": "/app-mcp-resource?limit=25&page=4" + "example": "/dsr-appointment-attendee?limit=25&page=4" }, "prev": { - "example": "/app-mcp-resource?limit=25&page=2" + "example": "/dsr-appointment-attendee?limit=25&page=2" } } } @@ -655,7 +655,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -670,11 +670,11 @@ }, "post": { "tags": [ - "App Mcp Resource" + "Dsr Appointment Attendee" ], - "summary": "Create a new App Mcp Resource resources.", - "description": "Available since: 6.7.0.0", - "operationId": "createAppMcpResource", + "summary": "Create a new Dsr Appointment Attendee resources.", + "description": "", + "operationId": "createDsrAppointmentAttendee", "parameters": [ { "name": "_response", @@ -693,14 +693,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } }, "responses": { "200": { - "description": "Detail of AppMcpResource", + "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -712,7 +712,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -727,7 +727,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -743,14 +743,14 @@ } } }, - "/search/app-mcp-resource": { + "/search/dsr-appointment-attendee": { "post": { "tags": [ - "App Mcp Resource" + "Dsr Appointment Attendee" ], - "summary": "Search for the App Mcp Resource resources.", - "description": "Available since: 6.7.0.0", - "operationId": "searchAppMcpResource", + "summary": "Search for the Dsr Appointment Attendee resources.", + "description": "", + "operationId": "searchDsrAppointmentAttendee", "parameters": [ { "name": "sw-include-search-info", @@ -778,7 +778,7 @@ }, "responses": { "200": { - "description": "List of AppMcpResource", + "description": "List of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -792,7 +792,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -810,7 +810,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -827,19 +827,19 @@ } } }, - "/app-mcp-resource/{id}": { + "/dsr-appointment-attendee/{id}": { "get": { "tags": [ - "App Mcp Resource" + "Dsr Appointment Attendee" ], - "summary": "Detailed information about a App Mcp Resource resource.", - "description": "Available since: 6.7.0.0", - "operationId": "getAppMcpResource", + "summary": "Detailed information about a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "getDsrAppointmentAttendee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_resource", + "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", @@ -849,7 +849,7 @@ ], "responses": { "200": { - "description": "Detail of AppMcpResource", + "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -861,7 +861,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -876,7 +876,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -893,16 +893,16 @@ }, "delete": { "tags": [ - "App Mcp Resource" + "Dsr Appointment Attendee" ], - "summary": "Delete a App Mcp Resource resource.", - "description": "Available since: 6.7.0.0", - "operationId": "deleteAppMcpResource", + "summary": "Delete a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "deleteDsrAppointmentAttendee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_resource", + "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", @@ -933,16 +933,16 @@ }, "patch": { "tags": [ - "App Mcp Resource" + "Dsr Appointment Attendee" ], - "summary": "Partially update information about a App Mcp Resource resource.", - "description": "Available since: 6.7.0.0", - "operationId": "updateAppMcpResource", + "summary": "Partially update information about a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "updateDsrAppointmentAttendee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_resource", + "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", @@ -960,18 +960,18 @@ } ], "requestBody": { - "description": "Partially update information about a App Mcp Resource resource.", + "description": "Partially update information about a Dsr Appointment Attendee resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } }, "responses": { "200": { - "description": "Detail of AppMcpResource", + "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -983,7 +983,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -998,7 +998,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -1017,14 +1017,14 @@ } } }, - "/aggregate/app-mcp-resource": { + "/aggregate/dsr-appointment-attendee": { "post": { "tags": [ - "App Mcp Resource" + "Dsr Appointment Attendee" ], - "summary": "Aggregate for the App Mcp Resource resources.", - "description": "Available since: 6.7.0.0", - "operationId": "aggregateAppMcpResource", + "summary": "Aggregate for the Dsr Appointment Attendee resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrAppointmentAttendee", "requestBody": { "required": true, "content": { @@ -1048,7 +1048,7 @@ }, "responses": { "200": { - "description": "List of AppMcpResource", + "description": "List of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -1062,7 +1062,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -1080,7 +1080,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpResource" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -1097,14 +1097,14 @@ } } }, - "/app-mcp-tool": { + "/dsr-appointment-request": { "get": { "tags": [ - "App Mcp Tool" + "Dsr Appointment Request" ], - "summary": "List with basic information of App Mcp Tool resources.", - "description": "Available since: 6.7.0.0", - "operationId": "getAppMcpToolList", + "summary": "List with basic information of Dsr Appointment Request resources.", + "description": "", + "operationId": "getDsrAppointmentRequestList", "parameters": [ { "name": "limit", @@ -1133,7 +1133,7 @@ ], "responses": { "200": { - "description": "List of App Mcp Tool resources.", + "description": "List of Dsr Appointment Request resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1152,7 +1152,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } ] @@ -1166,16 +1166,16 @@ "type": "object", "properties": { "first": { - "example": "/app-mcp-tool?limit=25" + "example": "/dsr-appointment-request?limit=25" }, "last": { - "example": "/app-mcp-tool?limit=25&page=11" + "example": "/dsr-appointment-request?limit=25&page=11" }, "next": { - "example": "/app-mcp-tool?limit=25&page=4" + "example": "/dsr-appointment-request?limit=25&page=4" }, "prev": { - "example": "/app-mcp-tool?limit=25&page=2" + "example": "/dsr-appointment-request?limit=25&page=2" } } } @@ -1196,7 +1196,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1211,11 +1211,11 @@ }, "post": { "tags": [ - "App Mcp Tool" + "Dsr Appointment Request" ], - "summary": "Create a new App Mcp Tool resources.", - "description": "Available since: 6.7.0.0", - "operationId": "createAppMcpTool", + "summary": "Create a new Dsr Appointment Request resources.", + "description": "", + "operationId": "createDsrAppointmentRequest", "parameters": [ { "name": "_response", @@ -1234,14 +1234,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } }, "responses": { "200": { - "description": "Detail of AppMcpTool", + "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1253,7 +1253,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1268,7 +1268,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1284,14 +1284,14 @@ } } }, - "/search/app-mcp-tool": { + "/search/dsr-appointment-request": { "post": { "tags": [ - "App Mcp Tool" + "Dsr Appointment Request" ], - "summary": "Search for the App Mcp Tool resources.", - "description": "Available since: 6.7.0.0", - "operationId": "searchAppMcpTool", + "summary": "Search for the Dsr Appointment Request resources.", + "description": "", + "operationId": "searchDsrAppointmentRequest", "parameters": [ { "name": "sw-include-search-info", @@ -1319,7 +1319,7 @@ }, "responses": { "200": { - "description": "List of AppMcpTool", + "description": "List of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1333,7 +1333,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1351,7 +1351,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1368,19 +1368,19 @@ } } }, - "/app-mcp-tool/{id}": { + "/dsr-appointment-request/{id}": { "get": { "tags": [ - "App Mcp Tool" + "Dsr Appointment Request" ], - "summary": "Detailed information about a App Mcp Tool resource.", - "description": "Available since: 6.7.0.0", - "operationId": "getAppMcpTool", + "summary": "Detailed information about a Dsr Appointment Request resource.", + "description": "", + "operationId": "getDsrAppointmentRequest", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_tool", + "description": "Identifier for the dsr_appointment_request", "required": true, "schema": { "type": "string", @@ -1390,7 +1390,7 @@ ], "responses": { "200": { - "description": "Detail of AppMcpTool", + "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1402,7 +1402,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1417,7 +1417,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1434,16 +1434,16 @@ }, "delete": { "tags": [ - "App Mcp Tool" + "Dsr Appointment Request" ], - "summary": "Delete a App Mcp Tool resource.", - "description": "Available since: 6.7.0.0", - "operationId": "deleteAppMcpTool", + "summary": "Delete a Dsr Appointment Request resource.", + "description": "", + "operationId": "deleteDsrAppointmentRequest", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_tool", + "description": "Identifier for the dsr_appointment_request", "required": true, "schema": { "type": "string", @@ -1474,16 +1474,16 @@ }, "patch": { "tags": [ - "App Mcp Tool" + "Dsr Appointment Request" ], - "summary": "Partially update information about a App Mcp Tool resource.", - "description": "Available since: 6.7.0.0", - "operationId": "updateAppMcpTool", + "summary": "Partially update information about a Dsr Appointment Request resource.", + "description": "", + "operationId": "updateDsrAppointmentRequest", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_mcp_tool", + "description": "Identifier for the dsr_appointment_request", "required": true, "schema": { "type": "string", @@ -1501,18 +1501,18 @@ } ], "requestBody": { - "description": "Partially update information about a App Mcp Tool resource.", + "description": "Partially update information about a Dsr Appointment Request resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } }, "responses": { "200": { - "description": "Detail of AppMcpTool", + "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1524,7 +1524,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1539,7 +1539,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1558,14 +1558,14 @@ } } }, - "/aggregate/app-mcp-tool": { + "/aggregate/dsr-appointment-request": { "post": { "tags": [ - "App Mcp Tool" + "Dsr Appointment Request" ], - "summary": "Aggregate for the App Mcp Tool resources.", - "description": "Available since: 6.7.0.0", - "operationId": "aggregateAppMcpTool", + "summary": "Aggregate for the Dsr Appointment Request resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrAppointmentRequest", "requestBody": { "required": true, "content": { @@ -1589,7 +1589,7 @@ }, "responses": { "200": { - "description": "List of AppMcpTool", + "description": "List of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1603,7 +1603,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1621,7 +1621,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppMcpTool" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1638,14 +1638,14 @@ } } }, - "/dsr-appointment": { + "/dsr-appointment-video-chat": { "get": { "tags": [ - "Dsr Appointment" + "Dsr Appointment Video Chat" ], - "summary": "List with basic information of Dsr Appointment resources.", + "summary": "List with basic information of Dsr Appointment Video Chat resources.", "description": "", - "operationId": "getDsrAppointmentList", + "operationId": "getDsrAppointmentVideoChatList", "parameters": [ { "name": "limit", @@ -1674,7 +1674,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment resources.", + "description": "List of Dsr Appointment Video Chat resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1693,7 +1693,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } ] @@ -1707,16 +1707,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment?limit=25" + "example": "/dsr-appointment-video-chat?limit=25" }, "last": { - "example": "/dsr-appointment?limit=25&page=11" + "example": "/dsr-appointment-video-chat?limit=25&page=11" }, "next": { - "example": "/dsr-appointment?limit=25&page=4" + "example": "/dsr-appointment-video-chat?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment?limit=25&page=2" + "example": "/dsr-appointment-video-chat?limit=25&page=2" } } } @@ -1737,7 +1737,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1752,11 +1752,11 @@ }, "post": { "tags": [ - "Dsr Appointment" + "Dsr Appointment Video Chat" ], - "summary": "Create a new Dsr Appointment resources.", + "summary": "Create a new Dsr Appointment Video Chat resources.", "description": "", - "operationId": "createDsrAppointment", + "operationId": "createDsrAppointmentVideoChat", "parameters": [ { "name": "_response", @@ -1775,14 +1775,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -1794,7 +1794,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1809,7 +1809,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1825,14 +1825,14 @@ } } }, - "/search/dsr-appointment": { + "/search/dsr-appointment-video-chat": { "post": { "tags": [ - "Dsr Appointment" + "Dsr Appointment Video Chat" ], - "summary": "Search for the Dsr Appointment resources.", + "summary": "Search for the Dsr Appointment Video Chat resources.", "description": "", - "operationId": "searchDsrAppointment", + "operationId": "searchDsrAppointmentVideoChat", "parameters": [ { "name": "sw-include-search-info", @@ -1860,7 +1860,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointment", + "description": "List of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -1874,7 +1874,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1892,7 +1892,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1909,19 +1909,19 @@ } } }, - "/dsr-appointment/{id}": { + "/dsr-appointment-video-chat/{id}": { "get": { "tags": [ - "Dsr Appointment" + "Dsr Appointment Video Chat" ], - "summary": "Detailed information about a Dsr Appointment resource.", + "summary": "Detailed information about a Dsr Appointment Video Chat resource.", "description": "", - "operationId": "getDsrAppointment", + "operationId": "getDsrAppointmentVideoChat", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment", + "description": "Identifier for the dsr_appointment_video_chat", "required": true, "schema": { "type": "string", @@ -1931,7 +1931,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -1943,7 +1943,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1958,7 +1958,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1975,16 +1975,16 @@ }, "delete": { "tags": [ - "Dsr Appointment" + "Dsr Appointment Video Chat" ], - "summary": "Delete a Dsr Appointment resource.", + "summary": "Delete a Dsr Appointment Video Chat resource.", "description": "", - "operationId": "deleteDsrAppointment", + "operationId": "deleteDsrAppointmentVideoChat", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment", + "description": "Identifier for the dsr_appointment_video_chat", "required": true, "schema": { "type": "string", @@ -2015,16 +2015,16 @@ }, "patch": { "tags": [ - "Dsr Appointment" + "Dsr Appointment Video Chat" ], - "summary": "Partially update information about a Dsr Appointment resource.", + "summary": "Partially update information about a Dsr Appointment Video Chat resource.", "description": "", - "operationId": "updateDsrAppointment", + "operationId": "updateDsrAppointmentVideoChat", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment", + "description": "Identifier for the dsr_appointment_video_chat", "required": true, "schema": { "type": "string", @@ -2042,18 +2042,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Appointment resource.", + "description": "Partially update information about a Dsr Appointment Video Chat resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -2065,7 +2065,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -2080,7 +2080,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -2099,14 +2099,14 @@ } } }, - "/aggregate/dsr-appointment": { + "/aggregate/dsr-appointment-video-chat": { "post": { "tags": [ - "Dsr Appointment" + "Dsr Appointment Video Chat" ], - "summary": "Aggregate for the Dsr Appointment resources.", + "summary": "Aggregate for the Dsr Appointment Video Chat resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointment", + "operationId": "aggregateDsrAppointmentVideoChat", "requestBody": { "required": true, "content": { @@ -2130,7 +2130,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointment", + "description": "List of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -2144,7 +2144,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -2162,7 +2162,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -2179,14 +2179,14 @@ } } }, - "/dsr-appointment-attendee": { + "/dsr-attendee-product-collection": { "get": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Attendee Product Collection" ], - "summary": "List with basic information of Dsr Appointment Attendee resources.", + "summary": "List with basic information of Dsr Attendee Product Collection resources.", "description": "", - "operationId": "getDsrAppointmentAttendeeList", + "operationId": "getDsrAttendeeProductCollectionList", "parameters": [ { "name": "limit", @@ -2215,7 +2215,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment Attendee resources.", + "description": "List of Dsr Attendee Product Collection resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2234,7 +2234,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } ] @@ -2248,16 +2248,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment-attendee?limit=25" + "example": "/dsr-attendee-product-collection?limit=25" }, "last": { - "example": "/dsr-appointment-attendee?limit=25&page=11" + "example": "/dsr-attendee-product-collection?limit=25&page=11" }, "next": { - "example": "/dsr-appointment-attendee?limit=25&page=4" + "example": "/dsr-attendee-product-collection?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment-attendee?limit=25&page=2" + "example": "/dsr-attendee-product-collection?limit=25&page=2" } } } @@ -2278,7 +2278,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2293,11 +2293,11 @@ }, "post": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Attendee Product Collection" ], - "summary": "Create a new Dsr Appointment Attendee resources.", + "summary": "Create a new Dsr Attendee Product Collection resources.", "description": "", - "operationId": "createDsrAppointmentAttendee", + "operationId": "createDsrAttendeeProductCollection", "parameters": [ { "name": "_response", @@ -2316,14 +2316,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentAttendee", + "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2335,7 +2335,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2350,7 +2350,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2366,14 +2366,14 @@ } } }, - "/search/dsr-appointment-attendee": { + "/search/dsr-attendee-product-collection": { "post": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Attendee Product Collection" ], - "summary": "Search for the Dsr Appointment Attendee resources.", + "summary": "Search for the Dsr Attendee Product Collection resources.", "description": "", - "operationId": "searchDsrAppointmentAttendee", + "operationId": "searchDsrAttendeeProductCollection", "parameters": [ { "name": "sw-include-search-info", @@ -2401,7 +2401,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentAttendee", + "description": "List of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2415,7 +2415,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2433,7 +2433,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2450,19 +2450,19 @@ } } }, - "/dsr-appointment-attendee/{id}": { + "/dsr-attendee-product-collection/{id}": { "get": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Attendee Product Collection" ], - "summary": "Detailed information about a Dsr Appointment Attendee resource.", + "summary": "Detailed information about a Dsr Attendee Product Collection resource.", "description": "", - "operationId": "getDsrAppointmentAttendee", + "operationId": "getDsrAttendeeProductCollection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_attendee", + "description": "Identifier for the dsr_attendee_product_collection", "required": true, "schema": { "type": "string", @@ -2472,7 +2472,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointmentAttendee", + "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2484,7 +2484,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2499,7 +2499,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2516,16 +2516,16 @@ }, "delete": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Attendee Product Collection" ], - "summary": "Delete a Dsr Appointment Attendee resource.", + "summary": "Delete a Dsr Attendee Product Collection resource.", "description": "", - "operationId": "deleteDsrAppointmentAttendee", + "operationId": "deleteDsrAttendeeProductCollection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_attendee", + "description": "Identifier for the dsr_attendee_product_collection", "required": true, "schema": { "type": "string", @@ -2556,16 +2556,16 @@ }, "patch": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Attendee Product Collection" ], - "summary": "Partially update information about a Dsr Appointment Attendee resource.", + "summary": "Partially update information about a Dsr Attendee Product Collection resource.", "description": "", - "operationId": "updateDsrAppointmentAttendee", + "operationId": "updateDsrAttendeeProductCollection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_attendee", + "description": "Identifier for the dsr_attendee_product_collection", "required": true, "schema": { "type": "string", @@ -2583,18 +2583,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Appointment Attendee resource.", + "description": "Partially update information about a Dsr Attendee Product Collection resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentAttendee", + "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2606,7 +2606,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2621,7 +2621,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2640,14 +2640,14 @@ } } }, - "/aggregate/dsr-appointment-attendee": { + "/aggregate/dsr-attendee-product-collection": { "post": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Attendee Product Collection" ], - "summary": "Aggregate for the Dsr Appointment Attendee resources.", + "summary": "Aggregate for the Dsr Attendee Product Collection resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointmentAttendee", + "operationId": "aggregateDsrAttendeeProductCollection", "requestBody": { "required": true, "content": { @@ -2671,7 +2671,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentAttendee", + "description": "List of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2685,7 +2685,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2703,7 +2703,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2720,14 +2720,14 @@ } } }, - "/dsr-appointment-request": { + "/dsr-cms-slide": { "get": { "tags": [ - "Dsr Appointment Request" + "Dsr Cms Slide" ], - "summary": "List with basic information of Dsr Appointment Request resources.", + "summary": "List with basic information of Dsr Cms Slide resources.", "description": "", - "operationId": "getDsrAppointmentRequestList", + "operationId": "getDsrCmsSlideList", "parameters": [ { "name": "limit", @@ -2756,7 +2756,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment Request resources.", + "description": "List of Dsr Cms Slide resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2775,7 +2775,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } ] @@ -2789,16 +2789,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment-request?limit=25" + "example": "/dsr-cms-slide?limit=25" }, "last": { - "example": "/dsr-appointment-request?limit=25&page=11" + "example": "/dsr-cms-slide?limit=25&page=11" }, "next": { - "example": "/dsr-appointment-request?limit=25&page=4" + "example": "/dsr-cms-slide?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment-request?limit=25&page=2" + "example": "/dsr-cms-slide?limit=25&page=2" } } } @@ -2819,7 +2819,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2834,11 +2834,11 @@ }, "post": { "tags": [ - "Dsr Appointment Request" + "Dsr Cms Slide" ], - "summary": "Create a new Dsr Appointment Request resources.", + "summary": "Create a new Dsr Cms Slide resources.", "description": "", - "operationId": "createDsrAppointmentRequest", + "operationId": "createDsrCmsSlide", "parameters": [ { "name": "_response", @@ -2857,14 +2857,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -2876,7 +2876,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2891,7 +2891,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2907,14 +2907,14 @@ } } }, - "/search/dsr-appointment-request": { + "/search/dsr-cms-slide": { "post": { "tags": [ - "Dsr Appointment Request" + "Dsr Cms Slide" ], - "summary": "Search for the Dsr Appointment Request resources.", + "summary": "Search for the Dsr Cms Slide resources.", "description": "", - "operationId": "searchDsrAppointmentRequest", + "operationId": "searchDsrCmsSlide", "parameters": [ { "name": "sw-include-search-info", @@ -2942,7 +2942,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentRequest", + "description": "List of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -2956,7 +2956,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2974,7 +2974,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2991,19 +2991,19 @@ } } }, - "/dsr-appointment-request/{id}": { + "/dsr-cms-slide/{id}": { "get": { "tags": [ - "Dsr Appointment Request" + "Dsr Cms Slide" ], - "summary": "Detailed information about a Dsr Appointment Request resource.", + "summary": "Detailed information about a Dsr Cms Slide resource.", "description": "", - "operationId": "getDsrAppointmentRequest", + "operationId": "getDsrCmsSlide", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_request", + "description": "Identifier for the dsr_cms_slide", "required": true, "schema": { "type": "string", @@ -3013,7 +3013,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -3025,7 +3025,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -3040,7 +3040,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -3057,16 +3057,16 @@ }, "delete": { "tags": [ - "Dsr Appointment Request" + "Dsr Cms Slide" ], - "summary": "Delete a Dsr Appointment Request resource.", + "summary": "Delete a Dsr Cms Slide resource.", "description": "", - "operationId": "deleteDsrAppointmentRequest", + "operationId": "deleteDsrCmsSlide", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_request", + "description": "Identifier for the dsr_cms_slide", "required": true, "schema": { "type": "string", @@ -3097,16 +3097,16 @@ }, "patch": { "tags": [ - "Dsr Appointment Request" + "Dsr Cms Slide" ], - "summary": "Partially update information about a Dsr Appointment Request resource.", + "summary": "Partially update information about a Dsr Cms Slide resource.", "description": "", - "operationId": "updateDsrAppointmentRequest", + "operationId": "updateDsrCmsSlide", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_request", + "description": "Identifier for the dsr_cms_slide", "required": true, "schema": { "type": "string", @@ -3124,18 +3124,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Appointment Request resource.", + "description": "Partially update information about a Dsr Cms Slide resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -3147,7 +3147,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -3162,7 +3162,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -3181,14 +3181,14 @@ } } }, - "/aggregate/dsr-appointment-request": { + "/aggregate/dsr-cms-slide": { "post": { "tags": [ - "Dsr Appointment Request" + "Dsr Cms Slide" ], - "summary": "Aggregate for the Dsr Appointment Request resources.", + "summary": "Aggregate for the Dsr Cms Slide resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointmentRequest", + "operationId": "aggregateDsrCmsSlide", "requestBody": { "required": true, "content": { @@ -3212,7 +3212,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentRequest", + "description": "List of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -3226,7 +3226,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -3244,7 +3244,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -3261,14 +3261,14 @@ } } }, - "/dsr-appointment-video-chat": { + "/dsr-interaction": { "get": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Interaction" ], - "summary": "List with basic information of Dsr Appointment Video Chat resources.", + "summary": "List with basic information of Dsr Interaction resources.", "description": "", - "operationId": "getDsrAppointmentVideoChatList", + "operationId": "getDsrInteractionList", "parameters": [ { "name": "limit", @@ -3297,7 +3297,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment Video Chat resources.", + "description": "List of Dsr Interaction resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3316,7 +3316,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } ] @@ -3330,16 +3330,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment-video-chat?limit=25" + "example": "/dsr-interaction?limit=25" }, "last": { - "example": "/dsr-appointment-video-chat?limit=25&page=11" + "example": "/dsr-interaction?limit=25&page=11" }, "next": { - "example": "/dsr-appointment-video-chat?limit=25&page=4" + "example": "/dsr-interaction?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment-video-chat?limit=25&page=2" + "example": "/dsr-interaction?limit=25&page=2" } } } @@ -3360,7 +3360,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3375,11 +3375,11 @@ }, "post": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Interaction" ], - "summary": "Create a new Dsr Appointment Video Chat resources.", + "summary": "Create a new Dsr Interaction resources.", "description": "", - "operationId": "createDsrAppointmentVideoChat", + "operationId": "createDsrInteraction", "parameters": [ { "name": "_response", @@ -3398,14 +3398,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentVideoChat", + "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -3417,7 +3417,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3432,7 +3432,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3448,14 +3448,14 @@ } } }, - "/search/dsr-appointment-video-chat": { + "/search/dsr-interaction": { "post": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Interaction" ], - "summary": "Search for the Dsr Appointment Video Chat resources.", + "summary": "Search for the Dsr Interaction resources.", "description": "", - "operationId": "searchDsrAppointmentVideoChat", + "operationId": "searchDsrInteraction", "parameters": [ { "name": "sw-include-search-info", @@ -3483,7 +3483,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentVideoChat", + "description": "List of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -3497,7 +3497,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3515,7 +3515,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3532,19 +3532,19 @@ } } }, - "/dsr-appointment-video-chat/{id}": { + "/dsr-interaction/{id}": { "get": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Interaction" ], - "summary": "Detailed information about a Dsr Appointment Video Chat resource.", + "summary": "Detailed information about a Dsr Interaction resource.", "description": "", - "operationId": "getDsrAppointmentVideoChat", + "operationId": "getDsrInteraction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", + "description": "Identifier for the dsr_interaction", "required": true, "schema": { "type": "string", @@ -3554,7 +3554,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointmentVideoChat", + "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -3566,7 +3566,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3581,7 +3581,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3598,16 +3598,16 @@ }, "delete": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Interaction" ], - "summary": "Delete a Dsr Appointment Video Chat resource.", + "summary": "Delete a Dsr Interaction resource.", "description": "", - "operationId": "deleteDsrAppointmentVideoChat", + "operationId": "deleteDsrInteraction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", + "description": "Identifier for the dsr_interaction", "required": true, "schema": { "type": "string", @@ -3638,16 +3638,16 @@ }, "patch": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Interaction" ], - "summary": "Partially update information about a Dsr Appointment Video Chat resource.", + "summary": "Partially update information about a Dsr Interaction resource.", "description": "", - "operationId": "updateDsrAppointmentVideoChat", + "operationId": "updateDsrInteraction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", + "description": "Identifier for the dsr_interaction", "required": true, "schema": { "type": "string", @@ -3665,18 +3665,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Appointment Video Chat resource.", + "description": "Partially update information about a Dsr Interaction resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentVideoChat", + "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -3688,7 +3688,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3703,7 +3703,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3722,14 +3722,14 @@ } } }, - "/aggregate/dsr-appointment-video-chat": { + "/aggregate/dsr-interaction": { "post": { "tags": [ - "Dsr Appointment Video Chat" + "Dsr Interaction" ], - "summary": "Aggregate for the Dsr Appointment Video Chat resources.", + "summary": "Aggregate for the Dsr Interaction resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointmentVideoChat", + "operationId": "aggregateDsrInteraction", "requestBody": { "required": true, "content": { @@ -3753,7 +3753,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentVideoChat", + "description": "List of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -3767,7 +3767,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3785,7 +3785,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3802,14 +3802,14 @@ } } }, - "/dsr-attendee-product-collection": { + "/dsr-presentation": { "get": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Presentation" ], - "summary": "List with basic information of Dsr Attendee Product Collection resources.", + "summary": "List with basic information of Dsr Presentation resources.", "description": "", - "operationId": "getDsrAttendeeProductCollectionList", + "operationId": "getDsrPresentationList", "parameters": [ { "name": "limit", @@ -3838,7 +3838,7 @@ ], "responses": { "200": { - "description": "List of Dsr Attendee Product Collection resources.", + "description": "List of Dsr Presentation resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3857,7 +3857,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } ] @@ -3871,16 +3871,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-attendee-product-collection?limit=25" + "example": "/dsr-presentation?limit=25" }, "last": { - "example": "/dsr-attendee-product-collection?limit=25&page=11" + "example": "/dsr-presentation?limit=25&page=11" }, "next": { - "example": "/dsr-attendee-product-collection?limit=25&page=4" + "example": "/dsr-presentation?limit=25&page=4" }, "prev": { - "example": "/dsr-attendee-product-collection?limit=25&page=2" + "example": "/dsr-presentation?limit=25&page=2" } } } @@ -3901,7 +3901,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3916,11 +3916,11 @@ }, "post": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Presentation" ], - "summary": "Create a new Dsr Attendee Product Collection resources.", + "summary": "Create a new Dsr Presentation resources.", "description": "", - "operationId": "createDsrAttendeeProductCollection", + "operationId": "createDsrPresentation", "parameters": [ { "name": "_response", @@ -3939,14 +3939,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } }, "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -3958,7 +3958,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3973,7 +3973,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3989,14 +3989,14 @@ } } }, - "/search/dsr-attendee-product-collection": { + "/search/dsr-presentation": { "post": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Presentation" ], - "summary": "Search for the Dsr Attendee Product Collection resources.", + "summary": "Search for the Dsr Presentation resources.", "description": "", - "operationId": "searchDsrAttendeeProductCollection", + "operationId": "searchDsrPresentation", "parameters": [ { "name": "sw-include-search-info", @@ -4024,7 +4024,7 @@ }, "responses": { "200": { - "description": "List of DsrAttendeeProductCollection", + "description": "List of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -4038,7 +4038,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4056,7 +4056,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4073,19 +4073,19 @@ } } }, - "/dsr-attendee-product-collection/{id}": { + "/dsr-presentation/{id}": { "get": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Presentation" ], - "summary": "Detailed information about a Dsr Attendee Product Collection resource.", + "summary": "Detailed information about a Dsr Presentation resource.", "description": "", - "operationId": "getDsrAttendeeProductCollection", + "operationId": "getDsrPresentation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", + "description": "Identifier for the dsr_presentation", "required": true, "schema": { "type": "string", @@ -4095,7 +4095,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -4107,7 +4107,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4122,7 +4122,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4139,16 +4139,16 @@ }, "delete": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Presentation" ], - "summary": "Delete a Dsr Attendee Product Collection resource.", + "summary": "Delete a Dsr Presentation resource.", "description": "", - "operationId": "deleteDsrAttendeeProductCollection", + "operationId": "deleteDsrPresentation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", + "description": "Identifier for the dsr_presentation", "required": true, "schema": { "type": "string", @@ -4179,16 +4179,16 @@ }, "patch": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Presentation" ], - "summary": "Partially update information about a Dsr Attendee Product Collection resource.", + "summary": "Partially update information about a Dsr Presentation resource.", "description": "", - "operationId": "updateDsrAttendeeProductCollection", + "operationId": "updateDsrPresentation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", + "description": "Identifier for the dsr_presentation", "required": true, "schema": { "type": "string", @@ -4206,18 +4206,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Attendee Product Collection resource.", + "description": "Partially update information about a Dsr Presentation resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } }, "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -4229,7 +4229,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4244,7 +4244,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4263,14 +4263,14 @@ } } }, - "/aggregate/dsr-attendee-product-collection": { + "/aggregate/dsr-presentation": { "post": { "tags": [ - "Dsr Attendee Product Collection" + "Dsr Presentation" ], - "summary": "Aggregate for the Dsr Attendee Product Collection resources.", + "summary": "Aggregate for the Dsr Presentation resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAttendeeProductCollection", + "operationId": "aggregateDsrPresentation", "requestBody": { "required": true, "content": { @@ -4294,7 +4294,7 @@ }, "responses": { "200": { - "description": "List of DsrAttendeeProductCollection", + "description": "List of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -4308,7 +4308,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4326,7 +4326,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -4343,14 +4343,14 @@ } } }, - "/dsr-cms-slide": { + "/dsr-presentation-cms-page": { "get": { "tags": [ - "Dsr Cms Slide" + "Dsr Presentation Cms Page" ], - "summary": "List with basic information of Dsr Cms Slide resources.", - "description": "", - "operationId": "getDsrCmsSlideList", + "summary": "List with basic information of Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getDsrPresentationCmsPageList", "parameters": [ { "name": "limit", @@ -4379,7 +4379,7 @@ ], "responses": { "200": { - "description": "List of Dsr Cms Slide resources.", + "description": "List of Dsr Presentation Cms Page resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4398,7 +4398,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } ] @@ -4412,16 +4412,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-cms-slide?limit=25" + "example": "/dsr-presentation-cms-page?limit=25" }, "last": { - "example": "/dsr-cms-slide?limit=25&page=11" + "example": "/dsr-presentation-cms-page?limit=25&page=11" }, "next": { - "example": "/dsr-cms-slide?limit=25&page=4" + "example": "/dsr-presentation-cms-page?limit=25&page=4" }, "prev": { - "example": "/dsr-cms-slide?limit=25&page=2" + "example": "/dsr-presentation-cms-page?limit=25&page=2" } } } @@ -4442,7 +4442,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4457,11 +4457,11 @@ }, "post": { "tags": [ - "Dsr Cms Slide" + "Dsr Presentation Cms Page" ], - "summary": "Create a new Dsr Cms Slide resources.", - "description": "", - "operationId": "createDsrCmsSlide", + "summary": "Create a new Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createDsrPresentationCmsPage", "parameters": [ { "name": "_response", @@ -4480,14 +4480,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } }, "responses": { "200": { - "description": "Detail of DsrCmsSlide", + "description": "Detail of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4499,7 +4499,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4514,7 +4514,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4530,14 +4530,14 @@ } } }, - "/search/dsr-cms-slide": { + "/search/dsr-presentation-cms-page": { "post": { "tags": [ - "Dsr Cms Slide" + "Dsr Presentation Cms Page" ], - "summary": "Search for the Dsr Cms Slide resources.", - "description": "", - "operationId": "searchDsrCmsSlide", + "summary": "Search for the Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDsrPresentationCmsPage", "parameters": [ { "name": "sw-include-search-info", @@ -4565,7 +4565,7 @@ }, "responses": { "200": { - "description": "List of DsrCmsSlide", + "description": "List of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4579,7 +4579,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4597,7 +4597,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4614,19 +4614,19 @@ } } }, - "/dsr-cms-slide/{id}": { + "/dsr-presentation-cms-page/{id}": { "get": { "tags": [ - "Dsr Cms Slide" + "Dsr Presentation Cms Page" ], - "summary": "Detailed information about a Dsr Cms Slide resource.", - "description": "", - "operationId": "getDsrCmsSlide", + "summary": "Detailed information about a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getDsrPresentationCmsPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_cms_slide", + "description": "Identifier for the dsr_presentation_cms_page", "required": true, "schema": { "type": "string", @@ -4636,7 +4636,7 @@ ], "responses": { "200": { - "description": "Detail of DsrCmsSlide", + "description": "Detail of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4648,7 +4648,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4663,7 +4663,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4680,16 +4680,16 @@ }, "delete": { "tags": [ - "Dsr Cms Slide" + "Dsr Presentation Cms Page" ], - "summary": "Delete a Dsr Cms Slide resource.", - "description": "", - "operationId": "deleteDsrCmsSlide", + "summary": "Delete a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteDsrPresentationCmsPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_cms_slide", + "description": "Identifier for the dsr_presentation_cms_page", "required": true, "schema": { "type": "string", @@ -4720,16 +4720,16 @@ }, "patch": { "tags": [ - "Dsr Cms Slide" + "Dsr Presentation Cms Page" ], - "summary": "Partially update information about a Dsr Cms Slide resource.", - "description": "", - "operationId": "updateDsrCmsSlide", + "summary": "Partially update information about a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateDsrPresentationCmsPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_cms_slide", + "description": "Identifier for the dsr_presentation_cms_page", "required": true, "schema": { "type": "string", @@ -4747,18 +4747,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Cms Slide resource.", + "description": "Partially update information about a Dsr Presentation Cms Page resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } }, "responses": { "200": { - "description": "Detail of DsrCmsSlide", + "description": "Detail of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4770,7 +4770,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4785,7 +4785,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4804,14 +4804,14 @@ } } }, - "/aggregate/dsr-cms-slide": { + "/aggregate/dsr-presentation-cms-page": { "post": { "tags": [ - "Dsr Cms Slide" + "Dsr Presentation Cms Page" ], - "summary": "Aggregate for the Dsr Cms Slide resources.", + "summary": "Aggregate for the Dsr Presentation Cms Page resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrCmsSlide", + "operationId": "aggregateDsrPresentationCmsPage", "requestBody": { "required": true, "content": { @@ -4835,7 +4835,7 @@ }, "responses": { "200": { - "description": "List of DsrCmsSlide", + "description": "List of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4849,7 +4849,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4867,7 +4867,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4884,213 +4884,233 @@ } } }, - "/dsr-interaction": { - "get": { + "/_action/dsr/appointment/{appointmentId}/join-as-guide": { + "post": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "List with basic information of Dsr Interaction resources.", - "description": "", - "operationId": "getDsrInteractionList", + "summary": "Join a meeting as a guide", + "description": "This route is used to join appointment as guide.", + "operationId": "joinAppointmentAsGuide", "parameters": [ { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { - "type": "integer" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } - }, + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JoinAppointmentResponse" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/start": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Start a presentation for a appointment", + "description": "Complete all needed data start the presentation", + "operationId": "startAppointment", + "parameters": [ { - "name": "page", - "in": "query", - "description": "The page to be returned", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { - "type": "integer" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } - }, + } + ], + "responses": { + "204": { + "description": "" + } + } + } + }, + "/_action/dsr/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": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { - "description": "List of Dsr Interaction resources.", + "description": "" + } + } + } + }, + "/_action/dsr/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", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-interaction?limit=25" - }, - "last": { - "example": "/dsr-interaction?limit=25&page=11" - }, - "next": { - "example": "/dsr-interaction?limit=25&page=4" - }, - "prev": { - "example": "/dsr-interaction?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } + "attendee-sw-context-token": { + "type": "string" } + }, + "example": { + "attendee-sw-context-token": "context token of attendee" } } } } - }, - "401": { - "$ref": "#/components/responses/401" } } - }, + } + }, + "/_action/dsr/appointment/{appointmentId}/instant-listing": { "post": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "Create a new Dsr Interaction resources.", - "description": "", - "operationId": "createDsrInteraction", + "summary": "Add a instant listing to the presentation", + "description": "Add a page as the instant listing to the presentation", + "operationId": "addInstantListing", "parameters": [ { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { "type": "string", - "enum": [ - "basic", - "detail" - ] + "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrInteraction" + "required": [ + "productIds" + ], + "properties": { + "productIds": { + "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}$" + }, + "pageName": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the instant listing page" + } + }, + "type": "object" } } } }, "responses": { - "200": { - "description": "Detail of DsrInteraction", + "201": { + "description": "Created a new instant listing", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" + "index": { + "type": "integer", + "description": "The current index of the instant listing which is created by this request" } + }, + "example": { + "index": 1 } } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } - } - }, - "/search/dsr-interaction": { - "post": { + }, + "patch": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "Search for the Dsr Interaction resources.", - "description": "", - "operationId": "searchDsrInteraction", + "summary": "Update a instant listing from the presentation", + "description": "Updates the products for the given listing", + "operationId": "updateInstantListing", "parameters": [ { - "name": "sw-include-search-info", - "in": "header", - "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" + "pattern": "^[0-9a-f]{32}$" } } ], @@ -5099,75 +5119,104 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "required": [ + "addProductIds", + "removeProductIds", + "currentPageGroupId" + ], + "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": { + "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}$" + }, + "pageName": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the instant listing page" + } + }, + "type": "object" } } } }, "responses": { "200": { - "description": "List of DsrInteraction", + "description": "Updated the instant listing", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", "properties": { - "total": { - "type": "integer" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the instant listing page" }, - "data": { + "pickedProductIds": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrInteraction" - } + "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" } + }, + "example": { + "id": "018c3e5ffd3a70899fa1321bf7e2a7f7", + "pickedProductIds": [ + "018c19b80403709cb2cef54f70860042", + "018c19b804027291955d8f076c272d0d" + ], + "title": "Default Digital Sales Rooms product listing page" } } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-interaction/{id}": { + "/_action/dsr/appointment/{appointmentId}/presentation/state": { "get": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "Detailed information about a Dsr Interaction resource.", - "description": "", - "operationId": "getDsrInteraction", + "summary": "Get the current presentation state", + "description": "Returns the presentation state for all and the guide", + "operationId": "getGuidePresentationState", "parameters": [ { - "name": "id", + "name": "appointmentId", "in": "path", - "description": "Identifier for the dsr_interaction", + "description": "Appointment id", "required": true, "schema": { "type": "string", @@ -5177,283 +5226,179 @@ ], "responses": { "200": { - "description": "Detail of DsrInteraction", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } + "$ref": "#/components/schemas/GuidePresentationStateResponse" } } } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } - }, - "delete": { + } + }, + "/_action/dsr/appointment/{appointmentId}/video-room": { + "post": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "Delete a Dsr Interaction resource.", - "description": "", - "operationId": "deleteDsrInteraction", + "summary": "Create a video room", + "description": "Creates a video room on the remote video tool", + "operationId": "createVideoRoom", "parameters": [ { - "name": "id", + "name": "appointmentId", "in": "path", - "description": "Identifier for the dsr_interaction", + "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } } ], "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VideoChatCreateStruct" + } + } + } } } }, - "patch": { + "delete": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "Partially update information about a Dsr Interaction resource.", - "description": "", - "operationId": "updateDsrInteraction", + "summary": "Delete a video room", + "description": "Delete a video room and tokens on the remote video tool", + "operationId": "deleteVideoRoom", "parameters": [ { - "name": "id", + "name": "appointmentId", "in": "path", - "description": "Identifier for the dsr_interaction", + "description": "Appointment id", "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": { + "200": { + "description": "", + "content": { + "application/json": [] } } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights": { + "get": { + "tags": [ + "Appointment" ], - "requestBody": { - "description": "Partially update information about a Dsr Interaction resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrInteraction" - } + "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}$" } } - }, + ], "responses": { "200": { - "description": "Detail of DsrInteraction", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } + "$ref": "#/components/schemas/GetAttendeeInsightsResponse" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/aggregate/dsr-interaction": { - "post": { + "/_action/dsr/appointment/{appointmentId}/widgets/cart-insights": { + "get": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "Aggregate for the Dsr Interaction resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrInteraction", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "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}$" } } - }, + ], "responses": { "200": { - "description": "List of DsrInteraction", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } + "$ref": "#/components/schemas/GetCartInsightsResponse" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-presentation": { + "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics": { "get": { "tags": [ - "Dsr Presentation" + "Appointment" ], - "summary": "List with basic information of Dsr Presentation resources.", - "description": "", - "operationId": "getDsrPresentationList", + "summary": "Get cart statistics", + "description": "Get cart statistics (cart line items) of all the attendees for the given appointment", + "operationId": "getCartStatistics", "parameters": [ { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { - "type": "integer" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, { - "name": "page", + "name": "order", "in": "query", - "description": "The page to be returned", + "description": "The order of the cart line items", "schema": { - "type": "integer" + "type": "string" } }, { - "name": "query", + "name": "sort", "in": "query", - "description": "Encoded SwagQL in JSON", + "description": "The sort of the cart line items", "schema": { "type": "string" } @@ -5461,254 +5406,185 @@ ], "responses": { "200": { - "description": "List of Dsr Presentation resources.", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-presentation?limit=25" - }, - "last": { - "example": "/dsr-presentation?limit=25&page=11" - }, - "next": { - "example": "/dsr-presentation?limit=25&page=4" - }, - "prev": { - "example": "/dsr-presentation?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "401": { - "$ref": "#/components/responses/401" } } - }, - "post": { + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics": { + "get": { "tags": [ - "Dsr Presentation" + "Appointment" ], - "summary": "Create a new Dsr Presentation resources.", - "description": "", - "operationId": "createDsrPresentation", + "summary": "Get last seen products insights", + "description": "Get last seen products of all attendees for the given appointment", + "operationId": "getLastSeenProductsInsights", "parameters": [ { - "name": "_response", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "limit", "in": "query", - "description": "Data format for response. Empty if none is provided.", + "description": "The limit of the products which should be returned", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "page", + "in": "query", + "description": "The page of the products which should be returned", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "term", + "in": "query", + "description": "The search term for the products", + "schema": { + "type": "string" + } + }, + { + "name": "attendeeId", + "in": "query", + "description": "The attendee id for which the last seen products should be returned", "schema": { "type": "string", - "enum": [ - "basic", - "detail" - ] + "pattern": "^[0-9a-f]{32}$" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - }, "responses": { "200": { - "description": "Detail of DsrPresentation", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } + "$ref": "#/components/schemas/WidgetProductListing" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/search/dsr-presentation": { - "post": { + "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics": { + "get": { "tags": [ - "Dsr Presentation" + "Appointment" ], - "summary": "Search for the Dsr Presentation resources.", - "description": "", - "operationId": "searchDsrPresentation", + "summary": "Get wishlist insights", + "description": "Get wishlist of all the attendees for the given appointment", + "operationId": "getWishlistInsights", "parameters": [ { - "name": "sw-include-search-info", - "in": "header", - "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" + "pattern": "^[0-9a-f]{32}$" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + }, + { + "name": "limit", + "in": "query", + "description": "The limit of the products which should be returned", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "page", + "in": "query", + "description": "The page of the products which should be returned", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "term", + "in": "query", + "description": "The search term for the wishlist products", + "schema": { + "type": "string" + } + }, + { + "name": "order", + "in": "query", + "description": "The order of the wishlist products", + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "in": "query", + "description": "The sort of the wishlist products", + "schema": { + "type": "string" + } + }, + { + "name": "attendeeId", + "in": "query", + "description": "The attendee id for which the wishlist products should be returned", + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of DsrPresentation", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } + "$ref": "#/components/schemas/WidgetProductListing" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-presentation/{id}": { - "get": { + "/_action/dsr/appointment/attendee/{attendeeId}/remove": { + "post": { "tags": [ - "Dsr Presentation" + "Appointment" ], - "summary": "Detailed information about a Dsr Presentation resource.", - "description": "", - "operationId": "getDsrPresentation", + "summary": "Remove an attendee from the appointment", + "description": "Remove an attendee from the appointment", + "operationId": "removeAttendee", "parameters": [ { - "name": "id", + "name": "attendeeId", "in": "path", - "description": "Identifier for the dsr_presentation", + "description": "Attendee id", "required": true, "schema": { "type": "string", @@ -5718,100 +5594,101 @@ ], "responses": { "200": { - "description": "Detail of DsrPresentation", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - ] - } - }, - "application/json": { + "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" + "message": { + "type": "string" + }, + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the removed attendee" } + }, + "example": { + "message": "Attendee removed successfully", + "attendeeId": "018c19b80403709cb2cef54f70860042" } } } } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } - }, - "delete": { + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids": { + "get": { "tags": [ - "Dsr Presentation" + "Appointment" ], - "summary": "Delete a Dsr Presentation resource.", - "description": "", - "operationId": "deleteDsrPresentation", + "summary": "Get ids of last seen products", + "description": "Get all product ids of that attendee has seen", + "operationId": "getLastSeenProductIds", "parameters": [ { - "name": "id", + "name": "attendeeId", "in": "path", - "description": "Identifier for the dsr_presentation", + "description": "Attendee id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } } ], "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "collection": { + "type": "object", + "properties": { + "lastSeen": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + } + } + }, + "example": { + "collection": { + "lastSeen": [ + "018c19b80403709cb2cef54f70860042", + "018c19b804027291955d8f076c272d0d" + ] + } + } + } + } + } } } - }, - "patch": { + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/load-temp-cart": { + "get": { "tags": [ - "Dsr Presentation" + "Appointment" ], - "summary": "Partially update information about a Dsr Presentation resource.", - "description": "", - "operationId": "updateDsrPresentation", + "summary": "Load a temporary cart for the attendee", + "description": "Load a temporary cart for the attendee", + "operationId": "loadTempCart", "parameters": [ { - "name": "id", + "name": "attendeeId", "in": "path", - "description": "Identifier for the dsr_presentation", + "description": "Attendee id", "required": true, "schema": { "type": "string", @@ -5819,360 +5696,157 @@ } }, { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, + "name": "sw-context-token", + "in": "header", + "description": "Contains sw-context-token value", "schema": { "type": "string" } } ], - "requestBody": { - "description": "Partially update information about a Dsr Presentation resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - }, "responses": { "200": { - "description": "Detail of DsrPresentation", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/aggregate/dsr-presentation": { + "/_action/dsr/appointment/attendee/{attendeeId}/add-temp-discount": { "post": { "tags": [ - "Dsr Presentation" + "Appointment" + ], + "summary": "Add discount to the temp cart", + "description": "Add discount to the temp cart", + "operationId": "addTempDiscount", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } ], - "summary": "Aggregate for the Dsr Presentation resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrPresentation", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/AddTempDiscountRequestBody" } } } }, "responses": { "200": { - "description": "List of DsrPresentation", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-presentation-cms-page": { - "get": { + "/_action/dsr/appointment/attendee/{attendeeId}/remove-temp-discount": { + "post": { "tags": [ - "Dsr Presentation Cms Page" + "Appointment" ], - "summary": "List with basic information of Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getDsrPresentationCmsPageList", + "summary": "Remove all discount from the temp cart", + "description": "Remove all discount from the temp cart", + "operationId": "removeTempDiscount", "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", + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { - "description": "List of Dsr Presentation Cms Page resources.", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-presentation-cms-page?limit=25" - }, - "last": { - "example": "/dsr-presentation-cms-page?limit=25&page=11" - }, - "next": { - "example": "/dsr-presentation-cms-page?limit=25&page=4" - }, - "prev": { - "example": "/dsr-presentation-cms-page?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "401": { - "$ref": "#/components/responses/401" } } - }, + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/apply-temp-discount": { "post": { "tags": [ - "Dsr Presentation Cms Page" + "Appointment" ], - "summary": "Create a new Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createDsrPresentationCmsPage", + "summary": "Apply the discount from the temp cart to the attendee cart", + "description": "Apply the discount from the temp cart to the attendee cart", + "operationId": "applyTempDiscount", "parameters": [ { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, "schema": { "type": "string", - "enum": [ - "basic", - "detail" - ] + "pattern": "^[0-9a-f]{32}$" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - }, "responses": { "200": { - "description": "Detail of DsrPresentationCmsPage", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/search/dsr-presentation-cms-page": { + "/_action/dsr/appointment/attendee/{attendeeId}/add-cart-discount": { "post": { "tags": [ - "Dsr Presentation Cms Page" + "Appointment" ], - "summary": "Search for the Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchDsrPresentationCmsPage", + "summary": "Add discount to the attendee cart", + "description": "Add discount to the attendee cart", + "operationId": "addCartDiscount", "parameters": [ { - "name": "sw-include-search-info", - "in": "header", - "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, "schema": { "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" + "pattern": "^[0-9a-f]{32}$" } } ], @@ -6181,2514 +5855,2198 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/AddCartDiscountRequestBody" } } } }, "responses": { "200": { - "description": "List of DsrPresentationCmsPage", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-presentation-cms-page/{id}": { - "get": { + "/_action/dsr/appointment/{appointmentId}/shopping-lists/{shoppingListId}": { + "post": { "tags": [ - "Dsr Presentation Cms Page" + "Appointment" ], - "summary": "Detailed information about a Dsr Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getDsrPresentationCmsPage", + "summary": "Load line item ids of a shopping lists from the appointment", + "description": "Load line item ids of a shopping lists from the appointment", + "operationId": "setSharingShoppingList", "parameters": [ { - "name": "id", + "name": "appointmentId", "in": "path", - "description": "Identifier for the dsr_presentation_cms_page", + "description": "The appointment id you are joining", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - } + }, + { + "name": "shoppingListId", + "in": "path", + "description": "The shopping list id you want to load", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } ], "responses": { "200": { - "description": "Detail of DsrPresentationCmsPage", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "type": "object", + "example": { + "data": { + "01938f89c632709ba4d65eb53604bf5b": { + "quantity": "1" + }, + "01938f89c8647036a617b7d88e1e24f5": { + "quantity": "1" + }, + "01938f8a23d47305b1e289163cea5074": { + "quantity": "1" + } + } + } } } } } } + } + }, + "security": [ + { + "ApiKey": [] + } + ] + } + } + }, + "components": { + "schemas": { + "success": { + "required": [ + "data" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" }, - "404": { - "$ref": "#/components/responses/404" + "links": { + "description": "Link members related to the primary data.", + "allOf": [ + { + "$ref": "#/components/schemas/links" + }, + { + "$ref": "#/components/schemas/pagination" + } + ] }, - "401": { - "$ref": "#/components/responses/401" + "data": { + "$ref": "#/components/schemas/data" + }, + "included": { + "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true } - } + }, + "type": "object", + "additionalProperties": false }, - "delete": { - "tags": [ - "Dsr Presentation Cms Page" + "failure": { + "required": [ + "errors" ], - "summary": "Delete a Dsr Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteDsrPresentationCmsPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_presentation_cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } + "links": { + "$ref": "#/components/schemas/links" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/error" + }, + "uniqueItems": true } + }, + "type": "object", + "additionalProperties": false + }, + "info": { + "required": [ + "meta" ], - "responses": { - "204": { - "$ref": "#/components/responses/204" + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" }, - "404": { - "$ref": "#/components/responses/404" + "links": { + "$ref": "#/components/schemas/links" }, - "401": { - "$ref": "#/components/responses/401" + "jsonapi": { + "$ref": "#/components/schemas/jsonapi" } - } + }, + "type": "object" }, - "patch": { - "tags": [ - "Dsr Presentation Cms Page" - ], - "summary": "Partially update information about a Dsr Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateDsrPresentationCmsPage", - "parameters": [ + "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": [ { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_presentation_cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "$ref": "#/components/schemas/resource" }, { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } + "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" ], - "requestBody": { - "description": "Partially update information about a Dsr Presentation Cms Page resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of DsrPresentationCmsPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - } - } + "properties": { + "type": { + "type": "string" }, - "400": { - "$ref": "#/components/responses/400" + "id": { + "type": "string" }, - "404": { - "$ref": "#/components/responses/404" + "attributes": { + "$ref": "#/components/schemas/attributes" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/dsr-presentation-cms-page": { - "post": { - "tags": [ - "Dsr Presentation Cms Page" - ], - "summary": "Aggregate for the Dsr Presentation Cms Page resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrPresentationCmsPage", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + "relationships": { + "$ref": "#/components/schemas/relationships" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "meta": { + "$ref": "#/components/schemas/meta" } }, - "responses": { - "200": { - "description": "List of DsrPresentationCmsPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - } - ] + "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" } }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - } + { + "$ref": "#/components/schemas/link" } - } - }, - "400": { - "$ref": "#/components/responses/400" + ] }, - "401": { - "$ref": "#/components/responses/401" + "related": { + "$ref": "#/components/schemas/link" } + }, + "type": "object", + "additionalProperties": true + }, + "links": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/link" } - } - }, - "/_action/number-range/{numberRangeId}/preview-pattern": { - "get": { - "tags": [ - "Number Range Management" - ], - "summary": "Preview a persisted number range", - "description": "Previews the next value for a concrete persisted number range without incrementing its state. Optional `pattern` and `start` query parameters can be used to preview unsaved changes while editing the number range. Use `/_action/number-range/reserve/{type}` for actual allocation by business type and sales channel.", - "operationId": "numberRangePreviewPatternById", - "parameters": [ + }, + "link": { + "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", + "oneOf": [ { - "name": "numberRangeId", - "in": "path", - "description": "Identifier of the number range to preview.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" }, { - "name": "pattern", - "in": "query", - "description": "Optional pattern override for the preview.", - "required": false, - "schema": { - "type": "string" + "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" + ] }, { - "name": "start", - "in": "query", - "description": "Optional start value override for the preview.", - "required": false, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "The previewed number", - "content": { - "application/json": { - "schema": { - "properties": { - "number": { - "description": "The previewed number.", - "type": "string" - } + "required": [ + "meta" + ] + }, + { + "required": [ + "links" + ] + }, + { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/relationshipLinks" + }, + "data": { + "description": "Member, whose value represents \"resource linkage\".", + "oneOf": [ + { + "$ref": "#/components/schemas/relationshipToOne" }, - "type": "object" - } + { + "$ref": "#/components/schemas/relationshipToMany" + } + ] } } - }, - "404": { - "description": "Number range not found" } - } - } - }, - "/_action/integration/{integrationId}/mcp-allowlist": { - "post": { - "tags": [ - "MCP", - "Experimental" ], - "summary": "Save MCP allowlist for an integration", - "description": "Saves the per-integration MCP allowlist covering tools, resources, and prompts. Pass `null` as the top-level value to allow all capabilities unrestricted. Pass an object with `tools`, `resources`, and `prompts` keys where each key is either `null` (unrestricted for that type) or a list of allowed names/URIs (empty array = deny all of that type). Requires `integration_mcp.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "saveMcpAllowlist", - "parameters": [ + "additionalProperties": false + }, + "relationshipToOne": { + "allOf": [ { - "name": "integrationId", - "in": "path", - "required": true, - "description": "The integration UUID.", - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "security": [ + "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." + }, { - "oAuth": [ - "write" - ] + "$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" ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "allowlist" - ], - "properties": { - "allowlist": { - "oneOf": [ - { - "type": "object", - "description": "Per-type allowlist. Each key is null (unrestricted) or a list of allowed names/URIs.", - "properties": { - "tools": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of allowed tool names. Empty array = no tools allowed." - }, - { - "type": "null", - "description": "Null = all tools allowed." - } - ] - }, - "resources": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of allowed resource URIs. Empty array = no resources allowed." - }, - { - "type": "null", - "description": "Null = all resources allowed." - } - ] - }, - "prompts": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of allowed prompt names. Empty array = no prompts allowed." - }, - { - "type": "null", - "description": "Null = all prompts allowed." - } - ] - } - } - }, - { - "type": "null", - "description": "Null = all capabilities unrestricted." - } - ] - } - } - } - } + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "meta": { + "$ref": "#/components/schemas/meta" } }, - "responses": { - "204": { - "description": "Allowlist saved successfully." - }, - "400": { - "description": "Bad request — missing or invalid `allowlist` field." + "type": "object", + "additionalProperties": false + }, + "pagination": { + "properties": { + "first": { + "description": "The first page of data", + "type": "string", + "format": "uri-reference" }, - "401": { - "description": "Unauthorized — missing or invalid credentials." + "last": { + "description": "The last page of data", + "type": "string", + "format": "uri-reference" }, - "403": { - "description": "Forbidden — caller lacks `integration_mcp.editor` privilege." + "prev": { + "description": "The previous page of data", + "type": "string", + "format": "uri-reference" }, - "404": { - "description": "Integration not found." - } - } - } - }, - "/_action/user/{userId}/mcp-allowlist": { - "post": { - "tags": [ - "MCP", - "Experimental" - ], - "summary": "Save MCP allowlist for a user", - "description": "Saves the per-user MCP allowlist covering tools, resources, and prompts. Pass `null` as the top-level value to allow all capabilities unrestricted. Pass an object with `tools`, `resources`, and `prompts` keys where each key is either `null` (unrestricted for that type) or a list of allowed names/URIs (empty array = deny all of that type). Requires `users_and_permissions.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "saveMcpAllowlistUser", - "parameters": [ - { - "name": "userId", - "in": "path", - "required": true, - "description": "The user UUID.", - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "security": [ - { - "oAuth": [ - "write" - ] + "next": { + "description": "The next page of data", + "type": "string", + "format": "uri-reference" } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "allowlist" - ], - "properties": { - "allowlist": { - "oneOf": [ - { - "type": "object", - "description": "Per-type allowlist. Each key is null (unrestricted) or a list of allowed names/URIs.", - "properties": { - "tools": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of allowed tool names. Empty array = no tools allowed." - }, - { - "type": "null", - "description": "Null = all tools allowed." - } - ] - }, - "resources": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of allowed resource URIs. Empty array = no resources allowed." - }, - { - "type": "null", - "description": "Null = all resources allowed." - } - ] - }, - "prompts": { - "oneOf": [ - { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of allowed prompt names. Empty array = no prompts allowed." - }, - { - "type": "null", - "description": "Null = all prompts allowed." - } - ] - } - } - }, - { - "type": "null", - "description": "Null = all capabilities unrestricted." - } - ] - } - } - } - } + }, + "type": "object" + }, + "jsonapi": { + "description": "An object describing the server's implementation", + "properties": { + "version": { + "type": "string" + }, + "meta": { + "$ref": "#/components/schemas/meta" } }, - "responses": { - "204": { - "description": "Allowlist saved successfully." + "type": "object", + "additionalProperties": false + }, + "error": { + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for this particular occurrence of the problem." }, - "400": { - "description": "Bad request — missing or invalid `allowlist` field." + "links": { + "$ref": "#/components/schemas/links" }, - "401": { - "description": "Unauthorized — missing or invalid credentials." + "status": { + "type": "string", + "description": "The HTTP status code applicable to this problem, expressed as a string value." }, - "403": { - "description": "Forbidden — caller lacks `users_and_permissions.editor` privilege." + "code": { + "type": "string", + "description": "An application-specific error code, expressed as a string value." }, - "404": { - "description": "User not found." + "title": { + "type": "string", + "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization." + }, + "detail": { + "type": "string", + "description": "A human-readable explanation specific to this occurrence of the problem." + }, + "description": { + "type": "string", + "description": "A human-readable description of the problem." + }, + "source": { + "type": "object", + "properties": { + "pointer": { + "type": "string", + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]." + }, + "parameter": { + "type": "string", + "description": "A string indicating which query parameter caused the error." + } + } + }, + "meta": { + "$ref": "#/components/schemas/meta" } - } - } - }, - "/_action/mcp/tools": { - "get": { - "tags": [ - "MCP", - "Experimental" - ], - "summary": "List registered MCP tools", - "description": "Returns all MCP tools currently registered on this Shopware installation. For all capability types (tools, resources, prompts) use `GET /_action/mcp/capabilities` instead. Requires `integration.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "mcpToolsList", - "security": [ + }, + "type": "object", + "additionalProperties": false + }, + "AclRoleJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ { - "oAuth": [ - "write" - ] - } - ], - "responses": { - "200": { - "description": "Array of registered MCP tools.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "required": [ - "name" - ], + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the ACL role defined.", + "type": "string" + }, + "description": { + "description": "A short description of the ACL role.", + "type": "string" + }, + "privileges": { + "type": "array", + "items": { + "type": "string" + } + }, + "deletedAt": { + "description": "Time and date when the ACL role was deleted.", + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "users": { "properties": { - "name": { - "type": "string", - "description": "Unique tool identifier used in `tools/call` requests.", - "example": "shopware-entity-search" - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Human-readable description of what the tool does.", - "example": "Search Shopware entities and return matching records." + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/users" + } + } }, - "dependencies": { + "data": { "type": "array", "items": { - "type": "string" - }, - "description": "Tool names that are automatically included when this tool is selected." - }, - "requiredPrivileges": { - "oneOf": [ - { - "type": "object", - "properties": { - "static": { - "type": "array", - "items": { - "type": "string" - } - }, - "entityParam": { - "type": [ - "string", - "null" - ] - }, - "operations": { - "type": "array", - "items": { - "type": "string" - } - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "example": "9bc65c2abec141778ffaa729489f3e87" } - }, - { - "type": "null" } - ], - "description": "ACL privileges required by this tool." + } } - } - } - } - } - } - }, - "401": { - "description": "Unauthorized — missing or invalid credentials." - }, - "403": { - "description": "Forbidden — caller lacks `integration.editor` privilege." - } - } - } - }, - "/_action/mcp/capabilities": { - "get": { - "tags": [ - "MCP", - "Experimental" - ], - "summary": "List all registered MCP capabilities", - "description": "Returns all registered MCP tools, resources, and prompts. Used by the Admin UI to populate the per-integration allowlist selector. Requires `integration.editor` privilege. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "mcpCapabilitiesList", - "security": [ - { - "oAuth": [ - "write" - ] - } - ], - "responses": { - "200": { - "description": "Object containing all registered MCP capabilities.", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tools", - "resources", - "prompts" - ], - "properties": { - "tools": { - "type": "array", - "items": { + }, + "type": "object" + }, + "app": { + "properties": { + "links": { "type": "object", - "required": [ - "name" - ], "properties": { - "name": { + "related": { "type": "string", - "example": "shopware-entity-search" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "dependencies": { - "type": "array", - "items": { - "type": "string" - } - }, - "requiredPrivileges": { - "oneOf": [ - { - "type": "object", - "properties": { - "static": { - "type": "array", - "items": { - "type": "string" - } - }, - "entityParam": { - "type": [ - "string", - "null" - ] - }, - "operations": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - { - "type": "null" - } - ] + "format": "uri-reference", + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/app" } } - } - }, - "resources": { - "type": "array", - "items": { + }, + "data": { "type": "object", - "required": [ - "uri", - "name" - ], "properties": { - "uri": { + "type": { "type": "string", - "example": "shopware://entity-list" + "example": "app" }, - "name": { + "id": { "type": "string", - "example": "shopware-entity-list" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "mimeType": { - "type": [ - "string", - "null" - ] + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, - "prompts": { - "type": "array", - "items": { + "type": "object" + }, + "integrations": { + "properties": { + "links": { "type": "object", - "required": [ - "name" - ], "properties": { - "name": { + "related": { "type": "string", - "example": "shopware-context" - }, - "description": { - "type": [ - "string", - "null" - ] + "format": "uri-reference", + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/integrations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "example": "415320131958c70f4f250ca4d7e63bbd" + } } } } - } + }, + "type": "object" } - } + }, + "type": "object" } - } - }, - "401": { - "description": "Unauthorized — missing or invalid credentials." - }, - "403": { - "description": "Forbidden — caller lacks `integration.editor` privilege." + }, + "type": "object" } - } - } - }, - "/_mcp": { - "post": { - "tags": [ - "MCP", - "Experimental" + ] + }, + "AclRole": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name" ], - "summary": "MCP JSON-RPC endpoint", - "description": "Handles Model Context Protocol (MCP) requests using the Streamable HTTP transport. Accepts JSON-RPC 2.0 messages for methods such as `initialize`, `tools/list`, `tools/call`, `prompts/list`, `prompts/get`, `resources/list`, and `resources/read`. Requires either an integration access key pair (`sw-access-key` + `sw-secret-access-key` headers) or a standard OAuth2 bearer token. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "mcpPost", - "parameters": [ - { - "name": "mcp-session-id", - "in": "header", - "required": false, - "description": "Session ID returned by the server after `initialize`. Required for all requests except `initialize`.", - "schema": { - "type": "string" - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "name": "sw-access-key", - "in": "header", - "required": false, - "description": "Integration access key for direct credential authentication (alternative to bearer token).", - "schema": { + "name": { + "description": "Name of the ACL role defined.", + "type": "string" + }, + "description": { + "description": "A short description of the ACL role.", + "type": "string" + }, + "privileges": { + "type": "array", + "items": { "type": "string" } }, - { - "name": "sw-secret-access-key", - "in": "header", - "required": false, - "description": "Integration secret access key. Required when `sw-access-key` is provided.", - "schema": { - "type": "string" + "deletedAt": { + "description": "Time and date when the ACL role was deleted.", + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" } - } - ], - "requestBody": { - "required": true, - "description": "A JSON-RPC 2.0 request or batch.", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "jsonrpc", - "method" - ], - "properties": { - "jsonrpc": { - "type": "string", - "enum": [ - "2.0" - ] - }, - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "null" - } - ] - }, - "method": { - "type": "string", - "example": "tools/call" - }, - "params": { - "type": "object", - "additionalProperties": true - } - } - } + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "integrations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" } } }, - "responses": { - "200": { - "description": "JSON-RPC response or Server-Sent Events stream for long-running operations.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "jsonrpc": { - "type": "string", - "enum": [ - "2.0" - ] - }, - "id": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "null" - } - ] - }, - "result": { - "type": "object", - "additionalProperties": true - }, - "error": { - "type": "object", - "properties": { - "code": { - "type": "integer" - }, - "message": { - "type": "string" - } - } - } - } - } - }, - "text/event-stream": { - "schema": { - "type": "string", - "description": "Server-Sent Events stream for streaming responses." - } - } - } - }, - "401": { - "description": "Unauthorized — missing or invalid credentials." - }, - "429": { - "description": "Too many requests — rate limit exceeded." - } - } + "type": "object" }, - "get": { - "tags": [ - "MCP", - "Experimental" - ], - "summary": "MCP SSE stream", - "description": "Opens a Server-Sent Events stream for receiving server-initiated messages. Used by MCP clients that support the SSE transport variant. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "mcpGet", - "parameters": [ - { - "name": "mcp-session-id", - "in": "header", - "required": false, - "schema": { - "type": "string" - } - } + "AclUserRole": { + "description": "Added since version: 6.0.0.0", + "required": [ + "userId", + "aclRoleId" ], - "responses": { - "200": { - "description": "Server-Sent Events stream.", - "content": { - "text/event-stream": { - "schema": { - "type": "string" - } - } - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "401": { - "description": "Unauthorized." + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "user": { + "$ref": "#/components/schemas/User" + }, + "aclRole": { + "$ref": "#/components/schemas/AclRole" } - } + }, + "type": "object" }, - "delete": { - "tags": [ - "MCP", - "Experimental" - ], - "summary": "Close MCP session", - "description": "Terminates an active MCP session identified by the `mcp-session-id` header. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "mcpDelete", - "parameters": [ + "AppJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ { - "name": "mcp-session-id", - "in": "header", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Session closed successfully." + "$ref": "#/components/schemas/resource" }, - "401": { - "description": "Unauthorized." - } - } - }, - "options": { - "tags": [ - "MCP", - "Experimental" - ], - "summary": "MCP CORS preflight", - "description": "Handles CORS preflight requests for the MCP endpoint. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "mcpOptions", - "responses": { - "204": { - "description": "CORS preflight accepted." - } - } - } - }, - "/_action/dsr/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": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JoinAppointmentResponse" + "required": [ + "id", + "name", + "path", + "version", + "integrationId", + "aclRoleId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the app.", + "type": "string" + }, + "path": { + "description": "A relative URL to the app.", + "type": "string" + }, + "author": { + "description": "Creator of the App.", + "type": "string" + }, + "copyright": { + "description": "Legal rights on the created app.", + "type": "string" + }, + "license": { + "description": "Software license's like MIT, etc.", + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", + "type": "boolean" + }, + "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", + "type": "boolean" + }, + "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", + "type": "string" + }, + "version": { + "description": "Version of the plugin.", + "type": "string" + }, + "icon": { + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "modules": { + "type": "array", + "items": { + "type": "object" } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/start": { - "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}$" - } - } - ], - "responses": { - "204": { - "description": "" - } - } - } - }, - "/_action/dsr/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/dsr/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", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "attendee-sw-context-token": { - "type": "string" - } - }, - "example": { - "attendee-sw-context-token": "context token of attendee" - } + }, + "mainModule": { + "type": "object" + }, + "cookies": { + "type": "array", + "items": { + "type": "object" } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/instant-listing": { - "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}$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "productIds" - ], + }, + "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", + "type": "boolean" + }, + "baseAppUrl": { + "description": "Root URL for an app.", + "type": "string" + }, + "allowedHosts": { + "type": "array", + "items": { + "type": "string" + } + }, + "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", + "type": "integer", + "format": "int64" + }, + "checkoutGatewayUrl": { + "type": "string" + }, + "contextGatewayUrl": { + "type": "string" + }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, + "requestedPrivileges": { + "type": "array", + "items": { + "type": "string" + } + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacyPolicyExtensions": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "integrationId": { + "description": "Unique identity of integration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "description": "Unique identity of ACL Role.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { "properties": { - "productIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" + } + } + } }, - "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}$" + "type": "object" }, - "pageName": { - "oneOf": [ - { - "type": "string" + "aclRole": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/aclRole" + } + } }, - { - "type": "null" + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "acl_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "250aa1c64b973365fd6fd489eefbdefc" + } + } } - ], - "description": "The name of the instant listing page" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "201": { - "description": "Created a new instant listing", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "index": { - "type": "integer", - "description": "The current index of the instant listing which is created by this request" - } + }, + "type": "object" }, - "example": { - "index": 1 - } - } - } - } - } - } - }, - "patch": { - "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}$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "addProductIds", - "removeProductIds", - "currentPageGroupId" - ], - "properties": { - "addProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" + } + } + } + } }, - "description": "Ids of the products which should be added to the instant listing" + "type": "object" }, - "removeProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" + } + } + } + } }, - "description": "Ids of the products which should be removed to the instant listing" + "type": "object" }, - "currentPageGroupId": { - "type": "string", - "description": "Id of the current cms page", - "pattern": "^[0-9a-f]{32}$" + "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" }, - "pageName": { - "oneOf": [ - { - "type": "string" + "webhooks": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/webhooks" + } + } }, - { - "type": "null" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "webhook" + }, + "id": { + "type": "string", + "example": "c10f40999b74c408263f790b30e70efe" + } + } + } } - ], - "description": "The name of the instant listing page" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Updated the instant listing", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the instant listing page" }, - "pickedProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "object" + }, + "paymentMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/paymentMethods" + } + } }, - "description": "Ids of the products which are picked for the instant listing" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_payment_method" + }, + "id": { + "type": "string", + "example": "b631b1ab565525e892f9cdc1242cca14" + } + } + } + } }, - "title": { - "type": "string", - "description": "The title of the instant listing" - } + "type": "object" }, - "example": { - "id": "018c3e5ffd3a70899fa1321bf7e2a7f7", - "pickedProductIds": [ - "018c19b80403709cb2cef54f70860042", - "018c19b804027291955d8f076c272d0d" - ], - "title": "Default Digital Sales Rooms product listing page" + "taxProviders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/taxProviders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_provider" + }, + "id": { + "type": "string", + "example": "01a1a9d428b6402dc8255d99c787a00e" + } + } + } + } + }, + "type": "object" + }, + "cmsBlocks": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_cms_block" + }, + "id": { + "type": "string", + "example": "3636c4901eab836dfb837e1a9a37d3c0" + } + } + } + } + }, + "type": "object" + }, + "flowActions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowActions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_flow_action" + }, + "id": { + "type": "string", + "example": "8d83a8af9d1b8b85dae9bdb76b7dbe7f" + } + } + } + } + }, + "type": "object" + }, + "flowEvents": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowEvents" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_flow_event" + }, + "id": { + "type": "string", + "example": "045e9ec14eafd26d17854fb4fe7c9cae" + } + } + } + } + }, + "type": "object" + }, + "appShippingMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/appShippingMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_shipping_method" + }, + "id": { + "type": "string", + "example": "1ad05ee47064647ee5b2dc8c12b1041c" + } + } + } + } + }, + "type": "object" + }, + "mcpTools": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/mcpTools" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_mcp_tool" + }, + "id": { + "type": "string", + "example": "6fd6afdbb8880347183b3fd75e779316" + } + } + } + } + }, + "type": "object" + }, + "mcpPrompts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/mcpPrompts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_mcp_prompt" + }, + "id": { + "type": "string", + "example": "dc6c2e9bc841c62a89cf5b3aa42f83d3" + } + } + } + } + }, + "type": "object" + }, + "mcpResources": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/mcpResources" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_mcp_resource" + }, + "id": { + "type": "string", + "example": "8357adcc66e1f74c8b7f688333874068" + } + } + } + } + }, + "type": "object" } - } + }, + "type": "object" } - } + }, + "type": "object" } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/presentation/state": { - "get": { - "tags": [ - "Appointment" + ] + }, + "App": { + "description": "Added since version: 6.3.1.0", + "required": [ + "id", + "name", + "path", + "version", + "integrationId", + "aclRoleId", + "label" ], - "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}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidePresentationStateResponse" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/video-room": { - "post": { - "tags": [ - "Appointment" - ], - "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}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VideoChatCreateStruct" - } - } - } - } - } - }, - "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": [] - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights": { - "get": { - "tags": [ - "Appointment" - ], - "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}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetAttendeeInsightsResponse" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/cart-insights": { - "get": { - "tags": [ - "Appointment" - ], - "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}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetCartInsightsResponse" - } - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the app.", + "type": "string" + }, + "path": { + "description": "A relative URL to the app.", + "type": "string" + }, + "author": { + "description": "Creator of the App.", + "type": "string" + }, + "copyright": { + "description": "Legal rights on the created app.", + "type": "string" + }, + "license": { + "description": "Software license's like MIT, etc.", + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", + "type": "boolean" + }, + "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", + "type": "boolean" + }, + "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", + "type": "string" + }, + "version": { + "description": "Version of the plugin.", + "type": "string" + }, + "icon": { + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "modules": { + "type": "array", + "items": { + "type": "object" } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics": { - "get": { - "tags": [ - "Appointment" - ], - "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}$" + }, + "mainModule": { + "type": "object" + }, + "cookies": { + "type": "array", + "items": { + "type": "object" } }, - { - "name": "order", - "in": "query", - "description": "The order of the cart line items", - "schema": { + "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", + "type": "boolean" + }, + "baseAppUrl": { + "description": "Root URL for an app.", + "type": "string" + }, + "allowedHosts": { + "type": "array", + "items": { "type": "string" } }, - { - "name": "sort", - "in": "query", - "description": "The sort of the cart line items", - "schema": { + "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", + "type": "integer", + "format": "int64" + }, + "checkoutGatewayUrl": { + "type": "string" + }, + "contextGatewayUrl": { + "type": "string" + }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, + "requestedPrivileges": { + "type": "array", + "items": { "type": "string" } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics": { - "get": { - "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}$" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacyPolicyExtensions": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "integrationId": { + "description": "Unique identity of integration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "description": "Unique identity of ACL Role.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "integration": { + "$ref": "#/components/schemas/Integration" + }, + "aclRole": { + "$ref": "#/components/schemas/AclRole" + }, + "customFieldSets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" } }, - { - "name": "limit", - "in": "query", - "description": "The limit of the products which should be returned", - "schema": { - "type": "integer", - "default": 10 + "actionButtons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" } }, - { - "name": "page", - "in": "query", - "description": "The page of the products which should be returned", - "schema": { - "type": "integer", - "default": 1 + "templates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" } }, - { - "name": "term", - "in": "query", - "description": "The search term for the products", - "schema": { - "type": "string" + "webhooks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" } }, - { - "name": "attendeeId", - "in": "query", - "description": "The attendee id for which the last seen products should be returned", - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WidgetProductListing" - } - } + }, + "taxProviders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics": { - "get": { - "tags": [ - "Appointment" - ], - "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}$" + }, + "cmsBlocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" } }, - { - "name": "limit", - "in": "query", - "description": "The limit of the products which should be returned", - "schema": { - "type": "integer", - "default": 10 + "flowActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" } }, - { - "name": "page", - "in": "query", - "description": "The page of the products which should be returned", - "schema": { - "type": "integer", - "default": 1 + "flowEvents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" } }, - { - "name": "term", - "in": "query", - "description": "The search term for the wishlist products", - "schema": { - "type": "string" + "appShippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" } }, - { - "name": "order", - "in": "query", - "description": "The order of the wishlist products", - "schema": { - "type": "string" + "mcpTools": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppMcpTool" } }, - { - "name": "sort", - "in": "query", - "description": "The sort of the wishlist products", - "schema": { - "type": "string" + "mcpPrompts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppMcpPrompt" } }, - { - "name": "attendeeId", - "in": "query", - "description": "The attendee id for which the wishlist products should be returned", - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "mcpResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppMcpResource" } } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WidgetProductListing" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/remove": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Remove an attendee from the appointment", - "description": "Remove an attendee from the appointment", - "operationId": "removeAttendee", - "parameters": [ + }, + "type": "object" + }, + "AppActionButtonJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the removed attendee" - } - }, - "example": { - "message": "Attendee removed successfully", - "attendeeId": "018c19b80403709cb2cef54f70860042" - } - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get ids of last seen products", - "description": "Get all product ids of that attendee has seen", - "operationId": "getLastSeenProductIds", - "parameters": [ + "$ref": "#/components/schemas/resource" + }, { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "collection": { - "type": "object", - "properties": { - "lastSeen": { - "type": "array", - "items": { + "required": [ + "id", + "entity", + "view", + "url", + "action", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "description": "Indicates in which particular entity.", + "type": "string" + }, + "view": { + "description": "Indicates whether it is detail page view or listing page view.", + "type": "string" + }, + "url": { + "description": "An url associated with the AppActionButton.", + "type": "string" + }, + "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "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", - "pattern": "^[0-9a-f]{32}$" + "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" } } } - } - }, - "example": { - "collection": { - "lastSeen": [ - "018c19b80403709cb2cef54f70860042", - "018c19b804027291955d8f076c272d0d" - ] - } + }, + "type": "object" } - } + }, + "type": "object" } - } + }, + "type": "object" } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/load-temp-cart": { - "get": { - "tags": [ - "Appointment" + ] + }, + "AppActionButton": { + "description": "Added since version: 6.3.1.0", + "required": [ + "id", + "entity", + "view", + "url", + "action", + "appId", + "label" ], - "summary": "Load a temporary cart for the attendee", - "description": "Load a temporary cart for the attendee", - "operationId": "loadTempCart", - "parameters": [ + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "description": "Indicates in which particular entity.", + "type": "string" + }, + "view": { + "description": "Indicates whether it is detail page view or listing page view.", + "type": "string" + }, + "url": { + "description": "An url associated with the AppActionButton.", + "type": "string" + }, + "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "AppAdministrationSnippetJsonApi": { + "description": "Added since version: 6.4.15.0", + "allOf": [ { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "$ref": "#/components/schemas/resource" }, { - "name": "sw-context-token", - "in": "header", - "description": "Contains sw-context-token value", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } + "required": [ + "id", + "value", + "appId", + "localeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "value": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/add-temp-discount": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Add discount to the temp cart", - "description": "Add discount to the temp cart", - "operationId": "addTempDiscount", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + }, + "type": "object" } + ] + }, + "AppAdministrationSnippet": { + "description": "Added since version: 6.4.15.0", + "required": [ + "id", + "value", + "appId", + "localeId" ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddTempDiscountRequestBody" - } - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "value": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } + "type": "object" + }, + "AppCmsBlockJsonApi": { + "description": "Added since version: 6.4.2.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "block", + "template", + "styles", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app's CMS block.", + "type": "string" + }, + "block": { + "type": "object" + }, + "template": { + "description": "Template that defines app CMS block.", + "type": "string" + }, + "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" } - } + }, + "type": "object" } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/remove-temp-discount": { - "post": { - "tags": [ - "Appointment" + ] + }, + "AppCmsBlock": { + "description": "Added since version: 6.4.2.0", + "required": [ + "id", + "name", + "block", + "template", + "styles", + "appId", + "label" ], - "summary": "Remove all discount from the temp cart", - "description": "Remove all discount from the temp cart", - "operationId": "removeTempDiscount", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/apply-temp-discount": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Apply the discount from the temp cart to the attendee cart", - "description": "Apply the discount from the temp cart to the attendee cart", - "operationId": "applyTempDiscount", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/add-cart-discount": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Add discount to the attendee cart", - "description": "Add discount to the attendee cart", - "operationId": "addCartDiscount", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddCartDiscountRequestBody" - } - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app's CMS block.", + "type": "string" + }, + "block": { + "type": "object" + }, + "template": { + "description": "Template that defines app CMS block.", + "type": "string" + }, + "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" } }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/shopping-lists/{shoppingListId}": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Load line item ids of a shopping lists from the appointment", - "description": "Load line item ids of a shopping lists from the appointment", - "operationId": "setSharingShoppingList", - "parameters": [ + "type": "object" + }, + "AppFlowActionJsonApi": { + "description": "Added since version: 6.4.10.0", + "allOf": [ { - "name": "appointmentId", - "in": "path", - "description": "The appointment id you are joining", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "$ref": "#/components/schemas/resource" }, { - "name": "shoppingListId", - "in": "path", - "description": "The shopping list id you want to load", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "example": { - "data": { - "01938f89c632709ba4d65eb53604bf5b": { - "quantity": "1" - }, - "01938f89c8647036a617b7d88e1e24f5": { - "quantity": "1" + "required": [ + "id", + "appId", + "name", + "url", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app flow action.", + "type": "string" + }, + "badge": { + "type": "string" + }, + "parameters": { + "type": "object" + }, + "config": { + "type": "object" + }, + "headers": { + "type": "object" + }, + "requirements": { + "type": "array", + "items": { + "type": "string" + } + }, + "iconRaw": { + "type": "string" + }, + "icon": { + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "swIcon": { + "type": "string" + }, + "url": { + "description": "An URL to app flow action.", + "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": { + "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" }, - "01938f8a23d47305b1e289163cea5074": { - "quantity": "1" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } - } + }, + "type": "object" + }, + "flowSequences": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow_sequence" + }, + "id": { + "type": "string", + "example": "3a0d70b6dd3624074e5e15cd07e7fa90" + } + } + } + } + }, + "type": "object" } - } + }, + "type": "object" } - } - } - }, - "security": [ - { - "ApiKey": [] + }, + "type": "object" } ] - } - } - }, - "components": { - "schemas": { - "success": { + }, + "AppFlowAction": { + "description": "Added since version: 6.4.10.0", "required": [ - "data" + "id", + "appId", + "name", + "url", + "label" ], "properties": { - "meta": { - "$ref": "#/components/schemas/meta" + "id": { + "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" - } - ] + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "data": { - "$ref": "#/components/schemas/data" + "name": { + "description": "Name of app flow action.", + "type": "string" }, - "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" + "badge": { + "type": "string" }, - "links": { - "$ref": "#/components/schemas/links" + "parameters": { + "type": "object" }, - "errors": { + "config": { + "type": "object" + }, + "headers": { + "type": "object" + }, + "requirements": { "type": "array", "items": { - "$ref": "#/components/schemas/error" - }, - "uniqueItems": true - } - }, - "type": "object", - "additionalProperties": false - }, - "info": { - "required": [ - "meta" - ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" + "type": "string" + } }, - "links": { - "$ref": "#/components/schemas/links" + "iconRaw": { + "type": "string" }, - "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" + "icon": { + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true }, - { - "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": { + "swIcon": { "type": "string" }, - "id": { + "url": { + "description": "An URL to app flow action.", "type": "string" }, - "attributes": { - "$ref": "#/components/schemas/attributes" + "delayable": { + "type": "boolean" }, - "relationships": { - "$ref": "#/components/schemas/relationships" + "label": { + "type": "string" }, - "links": { - "$ref": "#/components/schemas/links" + "description": { + "type": "string" }, - "meta": { - "$ref": "#/components/schemas/meta" - } - }, - "type": "object" - }, - "relationshipLinks": { - "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", - "properties": { - "self": { - "allOf": [ - { - "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", - "type": "array", - "items": { - "type": "object" - } - }, - { - "$ref": "#/components/schemas/link" - } - ] - }, - "related": { - "$ref": "#/components/schemas/link" - } - }, - "type": "object", - "additionalProperties": true - }, - "links": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/link" - } - }, - "link": { - "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", - "oneOf": [ - { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - { - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - "meta": { - "$ref": "#/components/schemas/meta" - } - } - } - ] - }, - "attributes": { - "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", - "type": "object", - "additionalProperties": true - }, - "relationships": { - "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", - "type": "object", - "anyOf": [ - { - "required": [ - "data" - ] - }, - { - "required": [ - "meta" - ] - }, - { - "required": [ - "links" - ] - }, - { - "type": "object", - "properties": { - "links": { - "$ref": "#/components/schemas/relationshipLinks" - }, - "data": { - "description": "Member, whose value represents \"resource linkage\".", - "oneOf": [ - { - "$ref": "#/components/schemas/relationshipToOne" - }, - { - "$ref": "#/components/schemas/relationshipToMany" - } - ] - } - } - } - ], - "additionalProperties": false - }, - "relationshipToOne": { - "allOf": [ - { - "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." - }, - { - "$ref": "#/components/schemas/linkage" - } - ] - }, - "relationshipToMany": { - "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", - "type": "array", - "items": { - "$ref": "#/components/schemas/linkage" - }, - "uniqueItems": true - }, - "linkage": { - "description": "The \"type\" and \"id\" to non-empty members.", - "required": [ - "type", - "id" - ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "meta": { - "$ref": "#/components/schemas/meta" - } - }, - "type": "object", - "additionalProperties": false - }, - "pagination": { - "properties": { - "first": { - "description": "The first page of data", - "type": "string", - "format": "uri-reference" - }, - "last": { - "description": "The last page of data", - "type": "string", - "format": "uri-reference" - }, - "prev": { - "description": "The previous page of data", - "type": "string", - "format": "uri-reference" - }, - "next": { - "description": "The next page of data", - "type": "string", - "format": "uri-reference" - } - }, - "type": "object" - }, - "jsonapi": { - "description": "An object describing the server's implementation", - "properties": { - "version": { + "headline": { "type": "string" }, - "meta": { - "$ref": "#/components/schemas/meta" - } - }, - "type": "object", - "additionalProperties": false - }, - "error": { - "properties": { - "id": { - "type": "string", - "description": "A unique identifier for this particular occurrence of the problem." - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "status": { - "type": "string", - "description": "The HTTP status code applicable to this problem, expressed as a string value." + "customFields": { + "type": "object" }, - "code": { + "createdAt": { "type": "string", - "description": "An application-specific error code, expressed as a string value." + "format": "date-time", + "readOnly": true }, - "title": { + "updatedAt": { "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." + "format": "date-time", + "readOnly": true }, - "detail": { - "type": "string", - "description": "A human-readable explanation specific to this occurrence of the problem." + "translated": { + "type": "object" }, - "description": { - "type": "string", - "description": "A human-readable description of the problem." + "app": { + "$ref": "#/components/schemas/App" }, - "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." - } + "flowSequences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" } - }, - "meta": { - "$ref": "#/components/schemas/meta" } }, - "type": "object", - "additionalProperties": false + "type": "object" }, - "AclRoleJsonApi": { - "description": "Added since version: 6.0.0.0", + "AppFlowEventJsonApi": { + "description": "Added since version: 6.5.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -8696,31 +8054,32 @@ { "required": [ "id", - "name" + "appId", + "name", + "aware" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of the ACL role defined.", - "type": "string" + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "description": "A short description of the ACL role.", + "name": { + "description": "Unique name of the AppFlowEvent.", "type": "string" }, - "privileges": { + "aware": { "type": "array", "items": { "type": "string" } }, - "deletedAt": { - "description": "Time and date when the ACL role was deleted.", - "type": "string", - "format": "date-time" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -8734,37 +8093,6 @@ }, "relationships": { "properties": { - "users": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/users" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "example": "9bc65c2abec141778ffaa729489f3e87" - } - } - } - } - }, - "type": "object" - }, "app": { "properties": { "links": { @@ -8773,7 +8101,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/app" + "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" } } }, @@ -8794,7 +8122,7 @@ }, "type": "object" }, - "integrations": { + "flows": { "properties": { "links": { "type": "object", @@ -8802,7 +8130,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/integrations" + "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" } } }, @@ -8813,11 +8141,11 @@ "properties": { "type": { "type": "string", - "example": "integration" + "example": "flow" }, "id": { "type": "string", - "example": "415320131958c70f4f250ca4d7e63bbd" + "example": "0db2dd944f9ee9a131f44b79d331d371" } } } @@ -8833,35 +8161,36 @@ } ] }, - "AclRole": { - "description": "Added since version: 6.0.0.0", + "AppFlowEvent": { + "description": "Added since version: 6.5.2.0", "required": [ "id", - "name" + "appId", + "name", + "aware" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of the ACL role defined.", - "type": "string" + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "description": "A short description of the ACL role.", + "name": { + "description": "Unique name of the AppFlowEvent.", "type": "string" }, - "privileges": { + "aware": { "type": "array", "items": { "type": "string" } }, - "deletedAt": { - "description": "Time and date when the ACL role was deleted.", - "type": "string", - "format": "date-time" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -8873,64 +8202,20 @@ "format": "date-time", "readOnly": true }, - "users": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } - }, "app": { "$ref": "#/components/schemas/App" }, - "integrations": { + "flows": { "type": "array", "items": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/Flow" } } }, "type": "object" }, - "AclUserRole": { - "description": "Added since version: 6.0.0.0", - "required": [ - "userId", - "aclRoleId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "aclRoleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "user": { - "$ref": "#/components/schemas/User" - }, - "aclRole": { - "$ref": "#/components/schemas/AclRole" - } - }, - "type": "object" - }, - "AppJsonApi": { - "description": "Added since version: 6.3.1.0", + "AppMcpPromptJsonApi": { + "description": "Added since version: 6.7.11.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -8939,10 +8224,8 @@ "required": [ "id", "name", - "path", - "version", - "integrationId", - "aclRoleId", + "url", + "appId", "label" ], "properties": { @@ -8951,103 +8234,14 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { - "description": "Name of the app.", - "type": "string" - }, - "path": { - "description": "A relative URL to the app.", - "type": "string" - }, - "author": { - "description": "Creator of the App.", - "type": "string" - }, - "copyright": { - "description": "Legal rights on the created app.", - "type": "string" - }, - "license": { - "description": "Software license's like MIT, etc.", - "type": "string" - }, - "active": { - "description": "When boolean value is `true`, the app is enabled for selection.", - "type": "boolean" - }, - "configurable": { - "description": "When boolean value is `true`, the app is configurable for further customizations.", - "type": "boolean" - }, - "privacy": { - "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", "type": "string" }, - "version": { - "description": "Version of the plugin.", + "url": { "type": "string" }, - "icon": { - "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", + "appId": { "type": "string", - "readOnly": true - }, - "modules": { - "type": "array", - "items": { - "type": "object" - } - }, - "mainModule": { - "type": "object" - }, - "cookies": { - "type": "array", - "items": { - "type": "object" - } - }, - "allowDisable": { - "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", - "type": "boolean" - }, - "baseAppUrl": { - "description": "Root URL for an app.", - "type": "string" - }, - "allowedHosts": { - "type": "array", - "items": { - "type": "string" - } - }, - "templateLoadPriority": { - "description": "A numerical value to prioritize one of the templates from the list.", - "type": "integer", - "format": "int64" - }, - "checkoutGatewayUrl": { - "type": "string" - }, - "contextGatewayUrl": { - "type": "string" - }, - "inAppPurchasesGatewayUrl": { - "type": "string" - }, - "sourceType": { - "type": "string" - }, - "sourceConfig": { - "type": "object" - }, - "selfManaged": { - "type": "boolean" - }, - "requestedPrivileges": { - "type": "array", - "items": { - "type": "string" - } + "pattern": "^[0-9a-f]{32}$" }, "label": { "type": "string" @@ -9055,22 +8249,6 @@ "description": { "type": "string" }, - "privacyPolicyExtensions": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "integrationId": { - "description": "Unique identity of integration.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "aclRoleId": { - "description": "Unique identity of ACL Role.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -9086,7 +8264,7 @@ }, "relationships": { "properties": { - "integration": { + "app": { "properties": { "links": { "type": "object", @@ -9094,7 +8272,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/integration" + "example": "/app-mcp-prompt/0f7619363286401a53877794cfb6ebbb/app" } } }, @@ -9103,48 +8281,133 @@ "properties": { "type": { "type": "string", - "example": "integration" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "776ea3bf11df5829827f7afb43c37174" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "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": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppMcpPrompt": { + "description": "Added since version: 6.7.11.0", + "required": [ + "id", + "name", + "url", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "AppMcpResourceJsonApi": { + "description": "Added since version: 6.7.11.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "uri", + "url", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "url": { + "type": "string" + }, + "mimeType": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "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", @@ -9152,30 +8415,148 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/customFieldSets" + "example": "/app-mcp-resource/30e270c9edfb6e58051d304c6e69e7bf/app" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_field_set" - }, - "id": { - "type": "string", - "example": "9b29ba872ce510f033b31364c8602760" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" - }, - "actionButtons": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppMcpResource": { + "description": "Added since version: 6.7.11.0", + "required": [ + "id", + "name", + "uri", + "url", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "url": { + "type": "string" + }, + "mimeType": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "AppMcpToolJsonApi": { + "description": "Added since version: 6.7.11.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "url", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string" + }, + "inputSchema": { + "type": "object" + }, + "requiredPrivileges": { + "type": "object" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "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", @@ -9183,30 +8564,168 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/actionButtons" + "example": "/app-mcp-tool/0d217ec15d0377a62d13caf5899f0212/app" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_action_button" - }, - "id": { - "type": "string", - "example": "2c7967427ed432e546ef1c0cb8d5da9e" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" - }, - "templates": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppMcpTool": { + "description": "Added since version: 6.7.11.0", + "required": [ + "id", + "name", + "url", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string" + }, + "inputSchema": { + "type": "object" + }, + "requiredPrivileges": { + "type": "object" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "AppPaymentMethodJsonApi": { + "description": "Added since version: 6.4.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "appName", + "identifier", + "paymentMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "description": "Name of the app.", + "type": "string" + }, + "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", + "type": "string" + }, + "payUrl": { + "description": "A URL sending the pay request.", + "type": "string" + }, + "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", + "type": "string" + }, + "validateUrl": { + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", + "type": "string" + }, + "captureUrl": { + "description": "A capture URL allows the payments to be processed and completed once validated.", + "type": "string" + }, + "refundUrl": { + "description": "A refund URL is used to initiate the refund process for a purchase.", + "type": "string" + }, + "recurringUrl": { + "description": "A URL to payment to handle recurring orders like subscriptions.", + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "description": "Unique identity of original media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "description": "Unique identity of payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "app": { "properties": { "links": { "type": "object", @@ -9214,30 +8733,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/templates" + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/app" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_template" - }, - "id": { - "type": "string", - "example": "fed36e93a0509e20f2dc96cbbd85b678" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "webhooks": { + "originalMedia": { "properties": { "links": { "type": "object", @@ -9245,30 +8762,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/webhooks" + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/originalMedia" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "webhook" - }, - "id": { - "type": "string", - "example": "c10f40999b74c408263f790b30e70efe" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "56386c66f82d9cd5639a5a7447971ead" } } } }, "type": "object" }, - "paymentMethods": { + "paymentMethod": { "properties": { "links": { "type": "object", @@ -9276,271 +8791,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/paymentMethods" + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/paymentMethod" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_payment_method" - }, - "id": { - "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" - } - } - } - } - }, - "type": "object" - }, - "taxProviders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/taxProviders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tax_provider" - }, - "id": { - "type": "string", - "example": "01a1a9d428b6402dc8255d99c787a00e" - } - } - } - } - }, - "type": "object" - }, - "cmsBlocks": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_cms_block" - }, - "id": { - "type": "string", - "example": "3636c4901eab836dfb837e1a9a37d3c0" - } - } - } - } - }, - "type": "object" - }, - "flowActions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowActions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_flow_action" - }, - "id": { - "type": "string", - "example": "8d83a8af9d1b8b85dae9bdb76b7dbe7f" - } - } - } - } - }, - "type": "object" - }, - "flowEvents": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowEvents" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_flow_event" - }, - "id": { - "type": "string", - "example": "045e9ec14eafd26d17854fb4fe7c9cae" - } - } - } - } - }, - "type": "object" - }, - "appShippingMethods": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/appShippingMethods" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_shipping_method" - }, - "id": { - "type": "string", - "example": "1ad05ee47064647ee5b2dc8c12b1041c" - } - } - } - } - }, - "type": "object" - }, - "mcpTools": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/mcpTools" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_mcp_tool" - }, - "id": { - "type": "string", - "example": "6fd6afdbb8880347183b3fd75e779316" - } - } - } - } - }, - "type": "object" - }, - "mcpPrompts": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/mcpPrompts" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_mcp_prompt" - }, - "id": { - "type": "string", - "example": "dc6c2e9bc841c62a89cf5b3aa42f83d3" - } - } - } - } - }, - "type": "object" - }, - "mcpResources": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { + "example": "payment_method" + }, + "id": { "type": "string", - "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/mcpResources" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_mcp_resource" - }, - "id": { - "type": "string", - "example": "8357adcc66e1f74c8b7f688333874068" - } + "pattern": "^[0-9a-f]{32}$", + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } @@ -9555,140 +8820,63 @@ } ] }, - "App": { - "description": "Added since version: 6.3.1.0", + "AppPaymentMethod": { + "description": "Added since version: 6.4.1.0", "required": [ "id", - "name", - "path", - "version", - "integrationId", - "aclRoleId", - "label" + "appName", + "identifier", + "paymentMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "appName": { "description": "Name of the app.", "type": "string" }, - "path": { - "description": "A relative URL to the app.", - "type": "string" - }, - "author": { - "description": "Creator of the App.", - "type": "string" - }, - "copyright": { - "description": "Legal rights on the created app.", - "type": "string" - }, - "license": { - "description": "Software license's like MIT, etc.", - "type": "string" - }, - "active": { - "description": "When boolean value is `true`, the app is enabled for selection.", - "type": "boolean" - }, - "configurable": { - "description": "When boolean value is `true`, the app is configurable for further customizations.", - "type": "boolean" - }, - "privacy": { - "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", - "type": "string" - }, - "version": { - "description": "Version of the plugin.", - "type": "string" - }, - "icon": { - "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "modules": { - "type": "array", - "items": { - "type": "object" - } - }, - "mainModule": { - "type": "object" - }, - "cookies": { - "type": "array", - "items": { - "type": "object" - } - }, - "allowDisable": { - "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", - "type": "boolean" - }, - "baseAppUrl": { - "description": "Root URL for an app.", - "type": "string" - }, - "allowedHosts": { - "type": "array", - "items": { - "type": "string" - } - }, - "templateLoadPriority": { - "description": "A numerical value to prioritize one of the templates from the list.", - "type": "integer", - "format": "int64" - }, - "checkoutGatewayUrl": { + "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", "type": "string" }, - "contextGatewayUrl": { + "payUrl": { + "description": "A URL sending the pay request.", "type": "string" }, - "inAppPurchasesGatewayUrl": { + "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", "type": "string" }, - "sourceType": { + "validateUrl": { + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", "type": "string" }, - "sourceConfig": { - "type": "object" - }, - "selfManaged": { - "type": "boolean" - }, - "requestedPrivileges": { - "type": "array", - "items": { - "type": "string" - } - }, - "label": { + "captureUrl": { + "description": "A capture URL allows the payments to be processed and completed once validated.", "type": "string" }, - "description": { + "refundUrl": { + "description": "A refund URL is used to initiate the refund process for a purchase.", "type": "string" }, - "privacyPolicyExtensions": { + "recurringUrl": { + "description": "A URL to payment to handle recurring orders like subscriptions.", "type": "string" }, - "customFields": { - "type": "object" + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "integrationId": { - "description": "Unique identity of integration.", + "originalMediaId": { + "description": "Unique identity of original media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "aclRoleId": { - "description": "Unique identity of ACL Role.", + "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9702,98 +8890,20 @@ "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" - } - }, - "actionButtons": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppActionButton" - } - }, - "templates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppTemplate" - } - }, - "webhooks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook" - } - }, - "paymentMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppPaymentMethod" - } - }, - "taxProviders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxProvider" - } - }, - "cmsBlocks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppCmsBlock" - } - }, - "flowActions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowAction" - } - }, - "flowEvents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowEvent" - } - }, - "appShippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } - }, - "mcpTools": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppMcpTool" - } + "app": { + "$ref": "#/components/schemas/App" }, - "mcpPrompts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppMcpPrompt" - } + "originalMedia": { + "$ref": "#/components/schemas/Media" }, - "mcpResources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppMcpResource" - } + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" }, - "AppActionButtonJsonApi": { - "description": "Added since version: 6.3.1.0", + "AppScriptConditionJsonApi": { + "description": "Added since version: 6.4.10.3", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -9801,37 +8911,38 @@ { "required": [ "id", - "entity", - "view", - "url", - "action", + "identifier", + "active", "appId", - "label" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entity": { - "description": "Indicates in which particular entity.", + "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", "type": "string" }, - "view": { - "description": "Indicates whether it is detail page view or listing page view.", + "name": { "type": "string" }, - "url": { - "description": "An url associated with the AppActionButton.", - "type": "string" + "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", + "type": "boolean" }, - "action": { - "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", + "group": { + "description": "Categorizes script conditions within a specific group.", "type": "string" }, - "label": { + "script": { + "description": "Internal field.", "type": "string" }, + "config": { + "type": "object" + }, "appId": { "description": "Unique identity of app.", "type": "string", @@ -9860,7 +8971,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" + "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" } } }, @@ -9880,50 +8991,82 @@ } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppActionButton": { - "description": "Added since version: 6.3.1.0", + }, + "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" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppScriptCondition": { + "description": "Added since version: 6.4.10.3", "required": [ "id", - "entity", - "view", - "url", - "action", + "identifier", + "active", "appId", - "label" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entity": { - "description": "Indicates in which particular entity.", + "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", "type": "string" }, - "view": { - "description": "Indicates whether it is detail page view or listing page view.", + "name": { "type": "string" }, - "url": { - "description": "An url associated with the AppActionButton.", - "type": "string" + "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", + "type": "boolean" }, - "action": { - "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", + "group": { + "description": "Categorizes script conditions within a specific group.", "type": "string" }, - "label": { + "script": { + "description": "Internal field.", "type": "string" }, + "config": { + "type": "object" + }, "appId": { "description": "Unique identity of app.", "type": "string", @@ -9944,12 +9087,18 @@ }, "app": { "$ref": "#/components/schemas/App" + }, + "ruleConditions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } } }, "type": "object" }, - "AppAdministrationSnippetJsonApi": { - "description": "Added since version: 6.4.15.0", + "AppShippingMethodJsonApi": { + "description": "Added since version: 6.5.7.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -9957,23 +9106,30 @@ { "required": [ "id", - "value", - "appId", - "localeId" + "appName", + "identifier", + "shippingMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "value": { + "appName": { + "type": "string" + }, + "identifier": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9986,33 +9142,132 @@ "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" } ] }, - "AppAdministrationSnippet": { - "description": "Added since version: 6.4.15.0", + "AppShippingMethod": { + "description": "Added since version: 6.5.7.0", "required": [ "id", - "value", - "appId", - "localeId" + "appName", + "identifier", + "shippingMethodId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "value": { + "appName": { + "type": "string" + }, + "identifier": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -10025,12 +9280,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" }, - "AppCmsBlockJsonApi": { - "description": "Added since version: 6.4.2.0", + "AppTemplateJsonApi": { + "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -10038,41 +9302,36 @@ { "required": [ "id", - "name", - "block", "template", - "styles", - "appId", - "label" + "path", + "active", + "appId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of app's CMS block.", - "type": "string" - }, - "block": { - "type": "object" - }, "template": { - "description": "Template that defines app CMS block.", + "description": "Template for an app.", "type": "string" }, - "styles": { - "description": "Parameter that relates to the styles or formatting within CMS block.", + "path": { + "description": "A relative URL to the app template.", "type": "string" }, - "label": { - "type": "string" + "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", + "type": "boolean" }, "appId": { "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "hash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -10083,9 +9342,6 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { "app": { @@ -10096,7 +9352,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" + "example": "/app-template/ca9106b8b82ff55b6fdce530ccb952a7/app" } } }, @@ -10125,45 +9381,40 @@ } ] }, - "AppCmsBlock": { - "description": "Added since version: 6.4.2.0", + "AppTemplate": { + "description": "Added since version: 6.3.1.0", "required": [ "id", - "name", - "block", "template", - "styles", - "appId", - "label" + "path", + "active", + "appId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of app's CMS block.", - "type": "string" - }, - "block": { - "type": "object" - }, "template": { - "description": "Template that defines app CMS block.", + "description": "Template for an app.", "type": "string" }, - "styles": { - "description": "Parameter that relates to the styles or formatting within CMS block.", + "path": { + "description": "A relative URL to the app template.", "type": "string" }, - "label": { - "type": "string" + "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", + "type": "boolean" }, "appId": { "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "hash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -10174,17 +9425,14 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, - "AppFlowActionJsonApi": { - "description": "Added since version: 6.4.10.0", + "CategoryJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -10192,72 +9440,160 @@ { "required": [ "id", - "appId", - "name", - "url", - "label" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appId": { - "description": "Unique identity of app.", + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Name of app flow action.", - "type": "string" + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "badge": { - "type": "string" + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "parameters": { - "type": "object" + "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object" + "afterCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "headers": { - "type": "object" + "mediaId": { + "description": "Unique identity of media added to identify category.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "requirements": { + "displayNestedProducts": { + "description": "Shows nested categories on a product category page.", + "type": "boolean" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "breadcrumb": { "type": "array", "items": { - "type": "string" - } + "type": "object", + "additionalProperties": false + }, + "readOnly": true }, - "iconRaw": { - "type": "string" + "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "icon": { - "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", + "path": { + "description": "A relative URL to the category.", "type": "string", "readOnly": true }, - "swIcon": { - "type": "string" + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true }, - "url": { - "description": "An URL to app flow action.", + "type": { + "description": "Type of categories like `page`, `folder`, `link`.", + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] + }, + "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", "type": "string" }, - "delayable": { + "visible": { + "description": "Displays categories on category page when true.", "type": "boolean" }, - "label": { + "active": { + "description": "When boolean value is `true`, the category is listed for selection.", + "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", + "enum": [ + "category", + "product", + "external", + "landing_page" + ] + }, + "internalLink": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalLink": { "type": "string" }, + "linkNewTab": { + "type": "boolean" + }, "description": { "type": "string" }, - "headline": { + "metaTitle": { "type": "string" }, - "customFields": { - "type": "object" + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "cmsPageId": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "description": "Unique identity of product stream.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customEntityTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true }, "createdAt": { "type": "string", @@ -10274,7 +9610,8 @@ }, "relationships": { "properties": { - "app": { + "parent": { + "description": "Unique identity of category.", "properties": { "links": { "type": "object", @@ -10282,7 +9619,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/parent" } } }, @@ -10291,19 +9628,20 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "category" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "flowSequences": { + "children": { + "description": "Child categories within this category for hierarchical navigation", "properties": { "links": { "type": "object", @@ -10311,7 +9649,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/children" } } }, @@ -10322,171 +9660,20 @@ "properties": { "type": { "type": "string", - "example": "flow_sequence" + "example": "category" }, "id": { "type": "string", - "example": "3a0d70b6dd3624074e5e15cd07e7fa90" + "example": "268184c12df027f536154d099d497b31" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppFlowAction": { - "description": "Added since version: 6.4.10.0", - "required": [ - "id", - "appId", - "name", - "url", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appId": { - "description": "Unique identity of app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Name of app flow action.", - "type": "string" - }, - "badge": { - "type": "string" - }, - "parameters": { - "type": "object" - }, - "config": { - "type": "object" - }, - "headers": { - "type": "object" - }, - "requirements": { - "type": "array", - "items": { - "type": "string" - } - }, - "iconRaw": { - "type": "string" - }, - "icon": { - "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", - "type": "string", - "readOnly": true - }, - "swIcon": { - "type": "string" - }, - "url": { - "description": "An URL to app flow action.", - "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" - } - } - }, - "type": "object" - }, - "AppFlowEventJsonApi": { - "description": "Added since version: 6.5.2.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "appId", - "name", - "aware" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appId": { - "description": "Unique identity of app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Unique name of the AppFlowEvent.", - "type": "string" - }, - "aware": { - "type": "array", - "items": { - "type": "string" - } - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "app": { + }, + "media": { + "description": "Category image or banner", "properties": { "links": { "type": "object", @@ -10494,7 +9681,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/media" } } }, @@ -10503,19 +9690,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "flows": { + "products": { "properties": { "links": { "type": "object", @@ -10523,7 +9710,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/products" } } }, @@ -10534,130 +9721,19 @@ "properties": { "type": { "type": "string", - "example": "flow" + "example": "product" }, "id": { "type": "string", - "example": "0db2dd944f9ee9a131f44b79d331d371" + "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppFlowEvent": { - "description": "Added since version: 6.5.2.0", - "required": [ - "id", - "appId", - "name", - "aware" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appId": { - "description": "Unique identity of app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Unique name of the AppFlowEvent.", - "type": "string" - }, - "aware": { - "type": "array", - "items": { - "type": "string" - } - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "app": { - "$ref": "#/components/schemas/App" - }, - "flows": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Flow" - } - } - }, - "type": "object" - }, - "AppMcpPromptJsonApi": { - "description": "Added since version: 6.7.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "url", - "appId", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "app": { + }, + "nestedProducts": { "properties": { "links": { "type": "object", @@ -10665,7 +9741,71 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-mcp-prompt/0f7619363286401a53877794cfb6ebbb/app" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/nestedProducts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "cf73cebf9ade7f94deba94ec71e66e43" + } + } + } + } + }, + "type": "object" + }, + "tags": { + "description": "Tags for organizing and filtering categories", + "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": { + "description": "CMS page layout for the category", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/cmsPage" } } }, @@ -10674,133 +9814,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "7b1460918b1abb93311108f3dc021c9b" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppMcpPrompt": { - "description": "Added since version: 6.7.0.0", - "required": [ - "id", - "name", - "url", - "appId", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "app": { - "$ref": "#/components/schemas/App" - } - }, - "type": "object" - }, - "AppMcpResourceJsonApi": { - "description": "Added since version: 6.7.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "uri", - "url", - "appId", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "uri": { - "type": "string" - }, - "url": { - "type": "string" - }, - "mimeType": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "app": { + }, + "productStream": { "properties": { "links": { "type": "object", @@ -10808,7 +9834,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-mcp-resource/30e270c9edfb6e58051d304c6e69e7bf/app" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/productStream" } } }, @@ -10817,139 +9843,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppMcpResource": { - "description": "Added since version: 6.7.0.0", - "required": [ - "id", - "name", - "uri", - "url", - "appId", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "uri": { - "type": "string" - }, - "url": { - "type": "string" - }, - "mimeType": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "app": { - "$ref": "#/components/schemas/App" - } - }, - "type": "object" - }, - "AppMcpToolJsonApi": { - "description": "Added since version: 6.7.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "url", - "appId", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string" - }, - "inputSchema": { - "type": "object" - }, - "requiredPrivileges": { - "type": "object" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "app": { + }, + "navigationSalesChannels": { "properties": { "links": { "type": "object", @@ -10957,168 +9863,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-mcp-tool/0d217ec15d0377a62d13caf5899f0212/app" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/navigationSalesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "04db458d860e0a4b455ae14b384a5e8a" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppMcpTool": { - "description": "Added since version: 6.7.0.0", - "required": [ - "id", - "name", - "url", - "appId", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string" - }, - "inputSchema": { - "type": "object" - }, - "requiredPrivileges": { - "type": "object" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "app": { - "$ref": "#/components/schemas/App" - } - }, - "type": "object" - }, - "AppPaymentMethodJsonApi": { - "description": "Added since version: 6.4.1.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "appName", - "identifier", - "paymentMethodId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appName": { - "description": "Name of the app.", - "type": "string" - }, - "identifier": { - "description": "It is a unique identity of an AppPaymentMethod.", - "type": "string" - }, - "payUrl": { - "description": "A URL sending the pay request.", - "type": "string" - }, - "finalizeUrl": { - "description": "A URL that redirects the user back to the shop.", - "type": "string" - }, - "validateUrl": { - "description": "A validate URL confirms the authenticity of a payment reference when accessed.", - "type": "string" - }, - "captureUrl": { - "description": "A capture URL allows the payments to be processed and completed once validated.", - "type": "string" - }, - "refundUrl": { - "description": "A refund URL is used to initiate the refund process for a purchase.", - "type": "string" - }, - "recurringUrl": { - "description": "A URL to payment to handle recurring orders like subscriptions.", - "type": "string" - }, - "appId": { - "description": "Unique identity of app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "originalMediaId": { - "description": "Unique identity of original media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "paymentMethodId": { - "description": "Unique identity of payment method.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "app": { + }, + "footerSalesChannels": { "properties": { "links": { "type": "object", @@ -11126,28 +9894,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/app" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/footerSalesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "57944aba1f6dea7ca9dacf66776e1755" + } } } } }, "type": "object" }, - "originalMedia": { + "serviceSalesChannels": { "properties": { "links": { "type": "object", @@ -11155,28 +9925,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/originalMedia" + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/serviceSalesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "56386c66f82d9cd5639a5a7447971ead" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "1a79932fadba3b20baf6369181e45602" + } } } } }, "type": "object" }, - "paymentMethod": { + "mainCategories": { "properties": { "links": { "type": "object", @@ -11184,21 +9956,55 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/paymentMethod" + "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": { + "description": "SEO-friendly URLs for the category across different sales channels", + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "payment_method" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "68ec1eeea9f1b7744e231b5bd0d97df0" + "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" + } } } } @@ -11213,66 +10019,165 @@ } ] }, - "AppPaymentMethod": { - "description": "Added since version: 6.4.1.0", + "Category": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "appName", - "identifier", - "paymentMethodId" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appName": { - "description": "Name of the app.", - "type": "string" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "description": "It is a unique identity of an AppPaymentMethod.", + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "description": "Unique identity of media added to identify category.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "displayNestedProducts": { + "description": "Shows nested categories on a product category page.", + "type": "boolean" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "breadcrumb": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "readOnly": true + }, + "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "description": "A relative URL to the category.", + "type": "string", + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "type": { + "description": "Type of categories like `page`, `folder`, `link`.", + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] + }, + "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", "type": "string" }, - "payUrl": { - "description": "A URL sending the pay request.", + "visible": { + "description": "Displays categories on category page when true.", + "type": "boolean" + }, + "active": { + "description": "When boolean value is `true`, the category is listed for selection.", + "type": "boolean" + }, + "visibleChildCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, + "name": { "type": "string" }, - "finalizeUrl": { - "description": "A URL that redirects the user back to the shop.", + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "linkType": { + "type": "string", + "enum": [ + "category", + "product", + "external", + "landing_page" + ] + }, + "internalLink": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalLink": { "type": "string" }, - "validateUrl": { - "description": "A validate URL confirms the authenticity of a payment reference when accessed.", + "linkNewTab": { + "type": "boolean" + }, + "description": { "type": "string" }, - "captureUrl": { - "description": "A capture URL allows the payments to be processed and completed once validated.", + "metaTitle": { "type": "string" }, - "refundUrl": { - "description": "A refund URL is used to initiate the refund process for a purchase.", + "metaDescription": { "type": "string" }, - "recurringUrl": { - "description": "A URL to payment to handle recurring orders like subscriptions.", + "keywords": { "type": "string" }, - "appId": { - "description": "Unique identity of app.", + "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "originalMediaId": { - "description": "Unique identity of original media.", + "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { - "description": "Unique identity of payment method.", + "productStreamId": { + "description": "Unique identity of product stream.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customEntityTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -11283,64 +10188,217 @@ "format": "date-time", "readOnly": true }, - "app": { - "$ref": "#/components/schemas/App" + "translated": { + "type": "object" }, - "originalMedia": { - "$ref": "#/components/schemas/Media" + "parent": { + "$ref": "#/components/schemas/Category", + "description": "Unique identity of category." }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - } - }, - "type": "object" - }, - "AppScriptConditionJsonApi": { - "description": "Added since version: 6.4.10.3", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "children": { + "description": "Child categories within this category for hierarchical navigation", + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } }, - { - "required": [ - "id", - "identifier", - "active", - "appId", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "identifier": { - "description": "It is a unique identity of an AppScriptCondition.", + "media": { + "$ref": "#/components/schemas/Media", + "description": "Category image or banner" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "nestedProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "tags": { + "description": "Tags for organizing and filtering categories", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the category" + }, + "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": { + "description": "SEO-friendly URLs for the category across different sales channels", + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + }, + "type": "object" + }, + "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": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "position", + "type", + "sectionId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", + "type": "integer", + "format": "int64" + }, + "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", "type": "string" }, + "locked": { + "type": "boolean" + }, "name": { + "description": "Unique name of the CMS Block.", "type": "string" }, - "active": { - "description": "When boolean value is `true`, defined app script conditions are available for selection.", - "type": "boolean" + "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", + "type": "string" }, - "group": { - "description": "Categorizes script conditions within a specific group.", + "marginTop": { + "description": "Defines the margin area on the top of an element.", "type": "string" }, - "script": { - "description": "Internal field.", + "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", "type": "string" }, - "config": { + "marginLeft": { + "description": "Defines for the margin area on the left of an element.", + "type": "string" + }, + "marginRight": { + "description": "Defines the margin area on the right of an element.", + "type": "string" + }, + "backgroundColor": { + "description": "Defines the background color of an element.", + "type": "string" + }, + "backgroundMediaId": { + "description": "Unique identity of background media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, "type": "object" }, - "appId": { - "description": "Unique identity of app.", + "sectionId": { + "description": "Unique identity of section.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -11351,12 +10409,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "app": { + "section": { "properties": { "links": { "type": "object", @@ -11364,7 +10419,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" + "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/section" } } }, @@ -11373,19 +10428,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "cms_section" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "73d5342eba070f636ac3246f319bf77f" } } } }, "type": "object" }, - "ruleConditions": { + "backgroundMedia": { "properties": { "links": { "type": "object", @@ -11393,7 +10448,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/ruleConditions" + "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" } } }, @@ -11404,11 +10488,11 @@ "properties": { "type": { "type": "string", - "example": "rule_condition" + "example": "cms_slot" }, "id": { "type": "string", - "example": "24bfabce4195894c9aed9b8bcfb0b748" + "example": "a8b72798beb911ae98c8c8907d45950a" } } } @@ -11424,47 +10508,102 @@ } ] }, - "AppScriptCondition": { - "description": "Added since version: 6.4.10.3", + "CmsBlock": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "identifier", - "active", - "appId", - "name" + "position", + "type", + "sectionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "description": "It is a unique identity of an AppScriptCondition.", + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", + "type": "integer", + "format": "int64" + }, + "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", "type": "string" }, + "locked": { + "type": "boolean" + }, "name": { + "description": "Unique name of the CMS Block.", "type": "string" }, - "active": { - "description": "When boolean value is `true`, defined app script conditions are available for selection.", - "type": "boolean" + "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", + "type": "string" }, - "group": { - "description": "Categorizes script conditions within a specific group.", + "marginTop": { + "description": "Defines the margin area on the top of an element.", "type": "string" }, - "script": { - "description": "Internal field.", + "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", "type": "string" }, - "config": { + "marginLeft": { + "description": "Defines for the margin area on the left of an element.", + "type": "string" + }, + "marginRight": { + "description": "Defines the margin area on the right of an element.", + "type": "string" + }, + "backgroundColor": { + "description": "Defines the background color of an element.", + "type": "string" + }, + "backgroundMediaId": { + "description": "Unique identity of background media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, "type": "object" }, - "appId": { - "description": "Unique identity of app.", + "sectionId": { + "description": "Unique identity of section.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -11475,23 +10614,23 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "section": { + "$ref": "#/components/schemas/CmsSection" }, - "app": { - "$ref": "#/components/schemas/App" + "backgroundMedia": { + "$ref": "#/components/schemas/Media" }, - "ruleConditions": { + "slots": { "type": "array", "items": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/CmsSlot" } } }, "type": "object" }, - "AppShippingMethodJsonApi": { - "description": "Added since version: 6.5.7.0", + "CmsPageJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -11499,33 +10638,51 @@ { "required": [ "id", - "appName", - "identifier", - "shippingMethodId" + "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appName": { + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { "type": "string" }, - "identifier": { + "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", "type": "string" }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "entity": { + "description": "This field will be implemented in the future.", + "type": "string" }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" }, - "originalMediaId": { + "config": { + "properties": { + "backgroundColor": { + "type": "string" + } + }, + "type": "object" + }, + "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, + "locked": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -11536,9 +10693,12 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "translated": { + "type": "object" + }, + "extensions": { "properties": { - "app": { + "createdBy": { "properties": { "links": { "type": "object", @@ -11546,7 +10706,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/app" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/createdBy" } } }, @@ -11555,19 +10715,57 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "34998857f537140306898d54d4b970dc" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/sections" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_section" + }, + "id": { + "type": "string", + "example": "ff4dee88db82e98f0e0d524d965b9aa7" + } } } } }, "type": "object" }, - "shippingMethod": { + "previewMedia": { + "description": "Preview image for the CMS page in admin panel and page selection", "properties": { "links": { "type": "object", @@ -11575,7 +10773,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/shippingMethod" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/previewMedia" } } }, @@ -11584,19 +10782,19 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + "example": "a7a817fb0e422cff87e878b8ff7ca914" } } } }, "type": "object" }, - "originalMedia": { + "categories": { "properties": { "links": { "type": "object", @@ -11604,140 +10802,62 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/originalMedia" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/categories" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" + } + } + } + } + }, + "type": "object" + }, + "landingPages": { + "description": "Landing pages using this CMS layout", + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "56386c66f82d9cd5639a5a7447971ead" + "format": "uri-reference", + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/landingPages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "landing_page" + }, + "id": { + "type": "string", + "example": "d60b77f2b3bd69591e3d5e3100926b4d" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppShippingMethod": { - "description": "Added since version: 6.5.7.0", - "required": [ - "id", - "appName", - "identifier", - "shippingMethodId" - ], - "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" - }, - "originalMedia": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "AppTemplateJsonApi": { - "description": "Added since version: 6.3.1.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "template", - "path", - "active", - "appId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "template": { - "description": "Template for an app.", - "type": "string" - }, - "path": { - "description": "A relative URL to the app template.", - "type": "string" - }, - "active": { - "description": "When boolean value is `true`, defined app templates are available for selection.", - "type": "boolean" - }, - "appId": { - "description": "Unique identity of app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "hash": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "app": { + }, + "homeSalesChannels": { "properties": { "links": { "type": "object", @@ -11745,21 +10865,54 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-template/ca9106b8b82ff55b6fdce530ccb952a7/app" + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/homeSalesChannels" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "9aed0c38161f67f2d40a4a872cae045f" + } + } + } + } + }, + "type": "object" + }, + "products": { + "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": "/cms-page/64bf107168bcd03626208c1764ce6890/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } } } } @@ -11774,39 +10927,54 @@ } ] }, - "AppTemplate": { - "description": "Added since version: 6.3.1.0", + "CmsPage": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "template", - "path", - "active", - "appId" + "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "template": { - "description": "Template for an app.", + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { "type": "string" }, - "path": { - "description": "A relative URL to the app template.", + "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", "type": "string" }, - "active": { - "description": "When boolean value is `true`, defined app templates are available for selection.", - "type": "boolean" + "entity": { + "description": "This field will be implemented in the future.", + "type": "string" }, - "appId": { - "description": "Unique identity of app.", + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "config": { + "properties": { + "backgroundColor": { + "type": "string" + } + }, + "type": "object" + }, + "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hash": { - "type": "string" + "customFields": { + "type": "object" + }, + "locked": { + "type": "boolean" }, "createdAt": { "type": "string", @@ -11818,13 +10986,83 @@ "format": "date-time", "readOnly": true }, - "app": { - "$ref": "#/components/schemas/App" + "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" + }, + "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + }, + "previewMedia": { + "$ref": "#/components/schemas/Media", + "description": "Preview image for the CMS page in admin panel and page selection" + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "landingPages": { + "description": "Landing pages using this CMS layout", + "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" }, - "CategoryJsonApi": { + "CmsSectionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -11833,7 +11071,9 @@ { "required": [ "id", - "name" + "position", + "type", + "pageId" ], "properties": { "id": { @@ -11844,149 +11084,76 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "afterCategoryId": { - "description": "Unique identity of the category under which the new category is to be created.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "afterCategoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "description": "Unique identity of media added to identify category.", + "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "displayNestedProducts": { - "description": "Shows nested categories on a product category page.", - "type": "boolean" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "breadcrumb": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - }, - "readOnly": true - }, - "level": { - "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "path": { - "description": "A relative URL to the category.", - "type": "string", - "readOnly": true - }, - "childCount": { + "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", "type": "integer", - "format": "int64", - "readOnly": true + "format": "int64" }, "type": { - "description": "Type of categories like `page`, `folder`, `link`.", + "description": "Types of sections can be `default` or `sidebar`.", "type": "string", "enum": [ - "page", - "link", - "folder" + "default", + "sidebar" ] }, - "productAssignmentType": { - "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", - "type": "string" - }, - "visible": { - "description": "Displays categories on category page when true.", - "type": "boolean" - }, - "active": { - "description": "When boolean value is `true`, the category is listed for selection.", + "locked": { "type": "boolean" }, - "visibleChildCount": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" - }, "name": { + "description": "Name of the CMS section defined.", "type": "string" }, - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" - }, - "linkType": { - "type": "string", - "enum": [ - "category", - "product", - "external", - "landing_page" - ] - }, - "internalLink": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "externalLink": { - "type": "string" - }, - "linkNewTab": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "metaTitle": { + "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", "type": "string" }, - "metaDescription": { + "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", "type": "string" }, - "keywords": { + "backgroundColor": { + "description": "Background color of CMS page.", "type": "string" }, - "cmsPageId": { - "description": "Unique identity of CMS page.", + "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", + "type": "string" }, - "productStreamId": { - "description": "Unique identity of product stream.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" }, - "customEntityTypeId": { + "pageId": { + "description": "Unique identity of page where CMS section is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageIdSwitched": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "deprecated": true + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -11998,13 +11165,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "relationships": { + "extensions": { "properties": { - "parent": { - "description": "Unique identity of category.", + "dsrSlideExtension": { "properties": { "links": { "type": "object", @@ -12012,7 +11175,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/parent" + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/dsrSlideExtension" } } }, @@ -12021,20 +11184,24 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "dsr_cms_slide" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "f7b1c34af8f346efae2c5862529520d8" } } } }, "type": "object" - }, - "children": { - "description": "Child categories within this category for hierarchical navigation", + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "page": { "properties": { "links": { "type": "object", @@ -12042,31 +11209,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/children" + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/page" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "category" - }, - "id": { - "type": "string", - "example": "268184c12df027f536154d099d497b31" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "71860c77c6745379b0d44304d66b6a13" } } } }, "type": "object" }, - "media": { - "description": "Category image or banner", + "backgroundMedia": { "properties": { "links": { "type": "object", @@ -12074,7 +11238,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/media" + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/backgroundMedia" } } }, @@ -12088,14 +11252,14 @@ "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "9f63714a30b4d0292695bd4d27235a0b" } } } }, "type": "object" }, - "products": { + "blocks": { "properties": { "links": { "type": "object", @@ -12103,7 +11267,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/products" + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/blocks" } } }, @@ -12114,289 +11278,11 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "cms_block" }, "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": { - "description": "Tags for organizing and filtering categories", - "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": { - "description": "CMS page layout for the category", - "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", - "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" - }, - "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" - } - } - } - } - }, - "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" - }, - "mainCategories": { - "properties": { - "links": { - "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" - } - } - } - } - }, - "type": "object" - }, - "seoUrls": { - "description": "SEO-friendly URLs for the category across different sales channels", - "properties": { - "links": { - "type": "object", - "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" + "example": "e734964953f880e5164e32827950ff92" } } } @@ -12412,11 +11298,13 @@ } ] }, - "Category": { + "CmsSection": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "name" + "position", + "type", + "pageId" ], "properties": { "id": { @@ -12427,149 +11315,76 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "afterCategoryId": { - "description": "Unique identity of the category under which the new category is to be created.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "afterCategoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaId": { - "description": "Unique identity of media added to identify category.", + "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "displayNestedProducts": { - "description": "Shows nested categories on a product category page.", - "type": "boolean" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "breadcrumb": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - }, - "readOnly": true - }, - "level": { - "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "path": { - "description": "A relative URL to the category.", - "type": "string", - "readOnly": true - }, - "childCount": { + "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", "type": "integer", - "format": "int64", - "readOnly": true + "format": "int64" }, "type": { - "description": "Type of categories like `page`, `folder`, `link`.", + "description": "Types of sections can be `default` or `sidebar`.", "type": "string", "enum": [ - "page", - "link", - "folder" + "default", + "sidebar" ] }, - "productAssignmentType": { - "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", - "type": "string" - }, - "visible": { - "description": "Displays categories on category page when true.", - "type": "boolean" - }, - "active": { - "description": "When boolean value is `true`, the category is listed for selection.", + "locked": { "type": "boolean" }, - "visibleChildCount": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "integer", - "format": "int64" - }, "name": { + "description": "Name of the CMS section defined.", "type": "string" }, - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" - }, - "linkType": { - "type": "string", - "enum": [ - "category", - "product", - "external", - "landing_page" - ] - }, - "internalLink": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "externalLink": { - "type": "string" - }, - "linkNewTab": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "metaTitle": { + "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", "type": "string" }, - "metaDescription": { + "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", "type": "string" }, - "keywords": { + "backgroundColor": { + "description": "Background color of CMS page.", "type": "string" }, - "cmsPageId": { - "description": "Unique identity of CMS page.", + "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", + "type": "string" }, - "productStreamId": { - "description": "Unique identity of product stream.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" }, - "customEntityTypeId": { + "pageId": { + "description": "Unique identity of page where CMS section is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageIdSwitched": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "deprecated": true + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -12581,128 +11396,67 @@ "format": "date-time", "readOnly": true }, - "translated": { + "extensions": { + "properties": { + "dsrSlideExtension": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/dsrSlideExtension" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_cms_slide" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f7b1c34af8f346efae2c5862529520d8" + } + } + } + }, + "type": "object" + } + }, "type": "object" }, - "parent": { - "$ref": "#/components/schemas/Category", - "description": "Unique identity of category." - }, - "children": { - "description": "Child categories within this category for hierarchical navigation", - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - }, - "media": { - "$ref": "#/components/schemas/Media", - "description": "Category image or banner" - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } + "page": { + "$ref": "#/components/schemas/CmsPage" }, - "nestedProducts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } + "backgroundMedia": { + "$ref": "#/components/schemas/Media" }, - "tags": { - "description": "Tags for organizing and filtering categories", + "blocks": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/CmsBlock" } - }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage", - "description": "CMS page layout for the category" - }, - "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": { - "description": "SEO-friendly URLs for the category across different sales channels", - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } - } - }, - "type": "object" - }, - "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": [ - { - "$ref": "#/components/schemas/resource" + } + }, + "type": "object" + }, + "CmsSlotJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, { "required": [ "id", - "position", "type", - "sectionId" + "slot", + "blockId" ], "properties": { "id": { @@ -12713,85 +11467,39 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsSectionVersionId": { + "cmsBlockVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "position": { - "description": "Order of the block indicated by number like 0, 1, 2,...", - "type": "integer", - "format": "int64" + "fieldConfig": { + "type": "object" }, "type": { - "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "name": { - "description": "Unique name of the CMS Block.", - "type": "string" - }, - "sectionPosition": { - "description": "Position of the section. It can either be `main` or `sidebar`.", - "type": "string" - }, - "marginTop": { - "description": "Defines the margin area on the top of an element.", - "type": "string" - }, - "marginBottom": { - "description": "Defines for the margin area on the bottom of an element.", - "type": "string" - }, - "marginLeft": { - "description": "Defines for the margin area on the left of an element.", - "type": "string" - }, - "marginRight": { - "description": "Defines the margin area on the right of an element.", + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", "type": "string" }, - "backgroundColor": { - "description": "Defines the background color of an element.", + "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", "type": "string" }, - "backgroundMediaId": { - "description": "Unique identity of background media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "backgroundMediaMode": { - "description": "Background media mode accept values `cover`, `auto`, `contain`.", - "type": "string" + "locked": { + "type": "boolean" }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", - "type": "string" + "config": { + "type": "object" }, - "visibility": { - "properties": { - "mobile": { - "type": "boolean" - }, - "desktop": { - "type": "boolean" - }, - "tablet": { - "type": "boolean" - } - }, + "customFields": { "type": "object" }, - "sectionId": { - "description": "Unique identity of section.", + "data": { + "type": "object", + "readOnly": true + }, + "blockId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -12802,38 +11510,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "section": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/section" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_section" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "73d5342eba070f636ac3246f319bf77f" - } - } - } - }, - "type": "object" - }, - "backgroundMedia": { + "block": { "properties": { "links": { "type": "object", @@ -12841,7 +11523,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/backgroundMedia" + "example": "/cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/block" } } }, @@ -12850,43 +11532,12 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "cms_block" }, "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" - } + "example": "14511f2f5564650d129ca7cabc333278" } } } @@ -12901,13 +11552,13 @@ } ] }, - "CmsBlock": { + "CmsSlot": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "position", "type", - "sectionId" + "slot", + "blockId" ], "properties": { "id": { @@ -12918,85 +11569,39 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsSectionVersionId": { + "cmsBlockVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "position": { - "description": "Order of the block indicated by number like 0, 1, 2,...", - "type": "integer", - "format": "int64" + "fieldConfig": { + "type": "object" }, "type": { - "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "name": { - "description": "Unique name of the CMS Block.", - "type": "string" - }, - "sectionPosition": { - "description": "Position of the section. It can either be `main` or `sidebar`.", - "type": "string" - }, - "marginTop": { - "description": "Defines the margin area on the top of an element.", - "type": "string" - }, - "marginBottom": { - "description": "Defines for the margin area on the bottom of an element.", - "type": "string" - }, - "marginLeft": { - "description": "Defines for the margin area on the left of an element.", - "type": "string" - }, - "marginRight": { - "description": "Defines the margin area on the right of an element.", + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", "type": "string" }, - "backgroundColor": { - "description": "Defines the background color of an element.", + "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", "type": "string" }, - "backgroundMediaId": { - "description": "Unique identity of background media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "backgroundMediaMode": { - "description": "Background media mode accept values `cover`, `auto`, `contain`.", - "type": "string" + "locked": { + "type": "boolean" }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", - "type": "string" + "config": { + "type": "object" }, - "visibility": { - "properties": { - "mobile": { - "type": "boolean" - }, - "desktop": { - "type": "boolean" - }, - "tablet": { - "type": "boolean" - } - }, + "customFields": { "type": "object" }, - "sectionId": { - "description": "Unique identity of section.", + "data": { + "type": "object", + "readOnly": true + }, + "blockId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -13007,22 +11612,16 @@ "format": "date-time", "readOnly": true }, - "section": { - "$ref": "#/components/schemas/CmsSection" - }, - "backgroundMedia": { - "$ref": "#/components/schemas/Media" + "translated": { + "type": "object" }, - "slots": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSlot" - } + "block": { + "$ref": "#/components/schemas/CmsBlock" } }, "type": "object" }, - "CmsPageJsonApi": { + "CountryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -13031,49 +11630,125 @@ { "required": [ "id", - "type" + "name", + "addressFormat" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "name": { "type": "string" }, - "type": { - "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", + "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", "type": "string" }, - "entity": { - "description": "This field will be implemented in the future.", + "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", + "type": "boolean" + }, + "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", + "type": "boolean" + }, + "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", "type": "string" }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", + "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", + "type": "boolean" + }, + "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", + "type": "boolean" + }, + "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", + "type": "boolean" + }, + "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", + "type": "boolean" + }, + "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", "type": "string" }, - "config": { + "customFields": { + "type": "object" + }, + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], "properties": { - "backgroundColor": { + "enabled": { + "type": "boolean" + }, + "currencyId": { "type": "string" + }, + "amount": { + "type": "number", + "format": "float" } }, "type": "object" }, - "previewMediaId": { - "description": "Unique identity of media to be previewed.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "companyTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" }, - "customFields": { + "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", + "type": "boolean" + }, + "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", + "type": "boolean" + }, + "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", + "type": "boolean" + }, + "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", + "type": "string" + }, + "addressFormat": { "type": "object" }, - "locked": { + "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", + "type": "string" + }, + "isEu": { "type": "boolean" }, "createdAt": { @@ -13089,9 +11764,10 @@ "translated": { "type": "object" }, - "extensions": { + "relationships": { "properties": { - "createdBy": { + "states": { + "description": "States/provinces/regions within the country", "properties": { "links": { "type": "object", @@ -13099,34 +11775,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/createdBy" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/states" } } }, "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": "country_state" + }, + "id": { + "type": "string", + "example": "34d955a0df5f7af9c9b4e4dccb3c3564" + } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "sections": { - "description": "Content sections within the CMS page (layout blocks containing slots)", + }, + "customerAddresses": { "properties": { "links": { "type": "object", @@ -13134,7 +11806,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/sections" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/customerAddresses" } } }, @@ -13145,11 +11817,11 @@ "properties": { "type": { "type": "string", - "example": "cms_section" + "example": "customer_address" }, "id": { "type": "string", - "example": "ff4dee88db82e98f0e0d524d965b9aa7" + "example": "84ed5cbc10cd9f665a8c9f05e49095af" } } } @@ -13157,8 +11829,7 @@ }, "type": "object" }, - "previewMedia": { - "description": "Preview image for the CMS page in admin panel and page selection", + "orderAddresses": { "properties": { "links": { "type": "object", @@ -13166,36 +11837,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/previewMedia" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/orderAddresses" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "a7a817fb0e422cff87e878b8ff7ca914" - } - } - } - }, - "type": "object" - }, - "categories": { - "properties": { - "links": { - "type": "object", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "example": "c3182f0dc0cc20b4982616d3e0221747" + } + } + } + } + }, + "type": "object" + }, + "salesChannelDefaultAssignments": { + "properties": { + "links": { + "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/categories" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannelDefaultAssignments" } } }, @@ -13206,11 +11879,11 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "sales_channel" }, "id": { "type": "string", - "example": "b0b5ccb4a195a07fd3eed14affb8695f" + "example": "b23663b2abc0909be9a8027a3fbff74b" } } } @@ -13218,8 +11891,7 @@ }, "type": "object" }, - "landingPages": { - "description": "Landing pages using this CMS layout", + "salesChannels": { "properties": { "links": { "type": "object", @@ -13227,7 +11899,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/landingPages" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannels" } } }, @@ -13238,11 +11910,11 @@ "properties": { "type": { "type": "string", - "example": "landing_page" + "example": "sales_channel" }, "id": { "type": "string", - "example": "d60b77f2b3bd69591e3d5e3100926b4d" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -13250,7 +11922,7 @@ }, "type": "object" }, - "homeSalesChannels": { + "taxRules": { "properties": { "links": { "type": "object", @@ -13258,7 +11930,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/homeSalesChannels" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/taxRules" } } }, @@ -13269,11 +11941,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "tax_rule" }, "id": { "type": "string", - "example": "9aed0c38161f67f2d40a4a872cae045f" + "example": "1b93ada511aac379c19d3afcba4e4041" } } } @@ -13281,7 +11953,7 @@ }, "type": "object" }, - "products": { + "currencyCountryRoundings": { "properties": { "links": { "type": "object", @@ -13289,7 +11961,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/products" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/currencyCountryRoundings" } } }, @@ -13300,11 +11972,11 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "currency_country_rounding" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "35ef8dd5459bf5f08d44cb278bf07cd4" } } } @@ -13320,53 +11992,129 @@ } ] }, - "CmsPage": { + "Country": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "type" + "name", + "addressFormat" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "name": { "type": "string" }, - "type": { - "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", + "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", "type": "string" }, - "entity": { - "description": "This field will be implemented in the future.", + "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", + "type": "boolean" + }, + "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", + "type": "boolean" + }, + "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", "type": "string" }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", + "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", + "type": "boolean" + }, + "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", + "type": "boolean" + }, + "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", + "type": "boolean" + }, + "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", + "type": "boolean" + }, + "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", "type": "string" }, - "config": { + "customFields": { + "type": "object" + }, + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], "properties": { - "backgroundColor": { + "enabled": { + "type": "boolean" + }, + "currencyId": { "type": "string" + }, + "amount": { + "type": "number", + "format": "float" } }, "type": "object" }, - "previewMediaId": { - "description": "Unique identity of media to be previewed.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "companyTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" }, - "customFields": { + "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", + "type": "boolean" + }, + "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", + "type": "boolean" + }, + "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", + "type": "boolean" + }, + "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", + "type": "string" + }, + "addressFormat": { "type": "object" }, - "locked": { + "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", + "type": "string" + }, + "isEu": { "type": "boolean" }, "createdAt": { @@ -13382,80 +12130,53 @@ "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" - }, - "sections": { - "description": "Content sections within the CMS page (layout blocks containing slots)", + "states": { + "description": "States/provinces/regions within the country", "type": "array", "items": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CountryState" } }, - "previewMedia": { - "$ref": "#/components/schemas/Media", - "description": "Preview image for the CMS page in admin panel and page selection" + "customerAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } }, - "categories": { + "orderAddresses": { "type": "array", "items": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/OrderAddress" } }, - "landingPages": { - "description": "Landing pages using this CMS layout", + "salesChannelDefaultAssignments": { "type": "array", "items": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/SalesChannel" } }, - "homeSalesChannels": { + "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, - "products": { + "taxRules": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/TaxRule" + } + }, + "currencyCountryRoundings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" } } }, "type": "object" }, - "CmsSectionJsonApi": { + "CountryStateJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -13464,87 +12185,36 @@ { "required": [ "id", - "position", - "type", - "pageId" + "countryId", + "shortCode", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "countryId": { + "description": "Unique identity of the country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "shortCode": { + "description": "An abbreviation for the country's state.", + "type": "string" + }, + "name": { + "type": "string" }, "position": { - "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", "type": "integer", "format": "int64" }, - "type": { - "description": "Types of sections can be `default` or `sidebar`.", - "type": "string", - "enum": [ - "default", - "sidebar" - ] - }, - "locked": { + "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", "type": "boolean" }, - "name": { - "description": "Name of the CMS section defined.", - "type": "string" - }, - "sizingMode": { - "description": "Sizing mode can be `boxed` or `full_width`.", - "type": "string" - }, - "mobileBehavior": { - "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", - "type": "string" - }, - "backgroundColor": { - "description": "Background color of CMS page.", - "type": "string" - }, - "backgroundMediaId": { - "description": "Unique identity of CMS section's background media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "backgroundMediaMode": { - "description": "Background media mode can be `cover`, `auto` or `contain`.", - "type": "string" - }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", - "type": "string" - }, - "pageId": { - "description": "Unique identity of page where CMS section is defined.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "visibility": { - "properties": { - "mobile": { - "type": "boolean" - }, - "desktop": { - "type": "boolean" - }, - "tablet": { - "type": "boolean" - } - }, - "type": "object" - }, "customFields": { "type": "object" }, @@ -13558,43 +12228,12 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "dsrSlideExtension": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/dsrSlideExtension" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "dsr_cms_slide" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f7b1c34af8f346efae2c5862529520d8" - } - } - } - }, - "type": "object" - } - }, + "translated": { "type": "object" }, "relationships": { "properties": { - "page": { + "country": { "properties": { "links": { "type": "object", @@ -13602,7 +12241,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/page" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/country" } } }, @@ -13611,19 +12250,19 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "71860c77c6745379b0d44304d66b6a13" + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, - "backgroundMedia": { + "customerAddresses": { "properties": { "links": { "type": "object", @@ -13631,28 +12270,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/backgroundMedia" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/customerAddresses" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9f63714a30b4d0292695bd4d27235a0b" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "example": "84ed5cbc10cd9f665a8c9f05e49095af" + } } } } }, "type": "object" }, - "blocks": { + "orderAddresses": { "properties": { "links": { "type": "object", @@ -13660,7 +12301,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/blocks" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/orderAddresses" } } }, @@ -13671,11 +12312,11 @@ "properties": { "type": { "type": "string", - "example": "cms_block" + "example": "order_address" }, "id": { "type": "string", - "example": "e734964953f880e5164e32827950ff92" + "example": "c3182f0dc0cc20b4982616d3e0221747" } } } @@ -13691,91 +12332,40 @@ } ] }, - "CmsSection": { + "CountryState": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "position", - "type", - "pageId" + "countryId", + "shortCode", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "countryId": { + "description": "Unique identity of the country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "shortCode": { + "description": "An abbreviation for the country's state.", + "type": "string" + }, + "name": { + "type": "string" }, "position": { - "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", "type": "integer", "format": "int64" }, - "type": { - "description": "Types of sections can be `default` or `sidebar`.", - "type": "string", - "enum": [ - "default", - "sidebar" - ] - }, - "locked": { + "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", "type": "boolean" }, - "name": { - "description": "Name of the CMS section defined.", - "type": "string" - }, - "sizingMode": { - "description": "Sizing mode can be `boxed` or `full_width`.", - "type": "string" - }, - "mobileBehavior": { - "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", - "type": "string" - }, - "backgroundColor": { - "description": "Background color of CMS page.", - "type": "string" - }, - "backgroundMediaId": { - "description": "Unique identity of CMS section's background media.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "backgroundMediaMode": { - "description": "Background media mode can be `cover`, `auto` or `contain`.", - "type": "string" - }, - "cssClass": { - "description": "One or more CSS classes added and separated by spaces.", - "type": "string" - }, - "pageId": { - "description": "Unique identity of page where CMS section is defined.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "visibility": { - "properties": { - "mobile": { - "type": "boolean" - }, - "desktop": { - "type": "boolean" - }, - "tablet": { - "type": "boolean" - } - }, - "type": "object" - }, "customFields": { "type": "object" }, @@ -13789,56 +12379,28 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "dsrSlideExtension": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/dsrSlideExtension" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "dsr_cms_slide" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f7b1c34af8f346efae2c5862529520d8" - } - } - } - }, - "type": "object" - } - }, + "translated": { "type": "object" }, - "page": { - "$ref": "#/components/schemas/CmsPage" + "country": { + "$ref": "#/components/schemas/Country" }, - "backgroundMedia": { - "$ref": "#/components/schemas/Media" + "customerAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } }, - "blocks": { + "orderAddresses": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/OrderAddress" } } }, "type": "object" }, - "CmsSlotJsonApi": { + "CurrencyJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -13847,303 +12409,97 @@ { "required": [ "id", - "type", - "slot", - "blockId" + "factor", + "symbol", + "isoCode", + "itemRounding", + "totalRounding", + "shortName", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsBlockVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fieldConfig": { - "type": "object" + "factor": { + "description": "Currency exchange rate.", + "type": "number", + "format": "float" }, - "type": { - "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", + "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", "type": "string" }, - "slot": { - "description": "Key-value pair to configure which element to be shown in which slot.", + "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", "type": "string" }, - "locked": { - "type": "boolean" - }, - "config": { - "type": "object" - }, - "customFields": { - "type": "object" - }, - "data": { - "type": "object", - "readOnly": true - }, - "blockId": { - "description": "Unique identity of CMS block where slot is defined.", - "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", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/block" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_block" - }, - "id": { - "type": "string", - "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}$" - }, - "cmsBlockVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fieldConfig": { - "type": "object" - }, - "type": { - "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", - "type": "string" - }, - "slot": { - "description": "Key-value pair to configure which element to be shown in which slot.", - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "config": { - "type": "object" - }, - "customFields": { - "type": "object" - }, - "data": { - "type": "object", - "readOnly": true - }, - "blockId": { - "description": "Unique identity of CMS block where slot is defined.", - "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": { + "shortName": { "type": "string" }, - "iso": { - "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", + "name": { "type": "string" }, "position": { - "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", + "description": "The order of the tabs for multiple currencies defined.", "type": "integer", "format": "int64" }, - "active": { - "description": "When boolean value is `true`, the country is available for selection in the storefront.", - "type": "boolean" - }, - "shippingAvailable": { - "description": "The shipping availability for a country is enabled when boolean value is `true`.", - "type": "boolean" - }, - "iso3": { - "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", - "type": "string" - }, - "displayStateInRegistration": { - "description": "The country's state is displayed in the address when boolean value is `true`.", - "type": "boolean" - }, - "forceStateInRegistration": { - "description": "State details in the address are force included when boolean value is `true`.", - "type": "boolean" - }, - "checkVatIdPattern": { - "description": "Verify if VAT ID is valid or not.", - "type": "boolean" - }, - "vatIdRequired": { - "description": "Set to true, if VAT ID is to be made mandatory.", + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "vatIdPattern": { - "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", - "type": "string" + "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", + "type": "number", + "format": "float" }, "customFields": { "type": "object" }, - "customerTax": { + "itemRounding": { "required": [ - "enabled", - "currencyId", - "amount" + "decimals", + "interval", + "roundForNet" ], "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" + "decimals": { + "type": "integer", + "format": "int64" }, - "amount": { + "interval": { "type": "number", "format": "float" + }, + "roundForNet": { + "type": "boolean" } }, "type": "object" }, - "companyTax": { + "totalRounding": { "required": [ - "enabled", - "currencyId", - "amount" + "decimals", + "interval", + "roundForNet" ], "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" + "decimals": { + "type": "integer", + "format": "int64" }, - "amount": { + "interval": { "type": "number", "format": "float" + }, + "roundForNet": { + "type": "boolean" } }, "type": "object" }, - "postalCodeRequired": { - "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", - "type": "boolean" - }, - "checkPostalCodePattern": { - "description": "Verify for valid postal code pattern.", - "type": "boolean" - }, - "checkAdvancedPostalCodePattern": { - "description": "Verify for advanced postal code pattern.", - "type": "boolean" - }, - "advancedPostalCodePattern": { - "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", - "type": "string" - }, - "addressFormat": { - "type": "object" - }, - "defaultPostalCodePattern": { - "description": "Default pattern of postal or zip code.", - "type": "string" - }, - "isEu": { - "type": "boolean" - }, "createdAt": { "type": "string", "format": "date-time", @@ -14159,8 +12515,7 @@ }, "relationships": { "properties": { - "states": { - "description": "States/provinces/regions within the country", + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -14168,7 +12523,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/states" + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDefaultAssignments" } } }, @@ -14179,11 +12534,11 @@ "properties": { "type": { "type": "string", - "example": "country_state" + "example": "sales_channel" }, "id": { "type": "string", - "example": "34d955a0df5f7af9c9b4e4dccb3c3564" + "example": "b23663b2abc0909be9a8027a3fbff74b" } } } @@ -14191,7 +12546,7 @@ }, "type": "object" }, - "customerAddresses": { + "orders": { "properties": { "links": { "type": "object", @@ -14199,7 +12554,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/customerAddresses" + "example": "/currency/386c339d37e737a436499d423a77df0c/orders" } } }, @@ -14210,11 +12565,11 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "order" }, "id": { "type": "string", - "example": "84ed5cbc10cd9f665a8c9f05e49095af" + "example": "12c500ed0b7879105fb46af0f246be87" } } } @@ -14222,7 +12577,7 @@ }, "type": "object" }, - "orderAddresses": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -14230,7 +12585,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/orderAddresses" + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannels" } } }, @@ -14241,11 +12596,11 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "sales_channel" }, "id": { "type": "string", - "example": "c3182f0dc0cc20b4982616d3e0221747" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -14253,7 +12608,7 @@ }, "type": "object" }, - "salesChannelDefaultAssignments": { + "salesChannelDomains": { "properties": { "links": { "type": "object", @@ -14261,7 +12616,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannelDefaultAssignments" + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDomains" } } }, @@ -14272,11 +12627,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "sales_channel_domain" }, "id": { "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" + "example": "b60ab8d110194bfe34ef9928ba48ab6d" } } } @@ -14284,7 +12639,7 @@ }, "type": "object" }, - "salesChannels": { + "promotionDiscountPrices": { "properties": { "links": { "type": "object", @@ -14292,7 +12647,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannels" + "example": "/currency/386c339d37e737a436499d423a77df0c/promotionDiscountPrices" } } }, @@ -14303,11 +12658,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "promotion_discount_prices" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "325723473ecab76b0f45e1554513f779" } } } @@ -14315,7 +12670,7 @@ }, "type": "object" }, - "taxRules": { + "productExports": { "properties": { "links": { "type": "object", @@ -14323,7 +12678,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/taxRules" + "example": "/currency/386c339d37e737a436499d423a77df0c/productExports" } } }, @@ -14334,11 +12689,11 @@ "properties": { "type": { "type": "string", - "example": "tax_rule" + "example": "product_export" }, "id": { "type": "string", - "example": "1b93ada511aac379c19d3afcba4e4041" + "example": "2cd8793787cda582174c0fc329fbc377" } } } @@ -14346,7 +12701,7 @@ }, "type": "object" }, - "currencyCountryRoundings": { + "countryRoundings": { "properties": { "links": { "type": "object", @@ -14354,7 +12709,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/currencyCountryRoundings" + "example": "/currency/386c339d37e737a436499d423a77df0c/countryRoundings" } } }, @@ -14369,7 +12724,7 @@ }, "id": { "type": "string", - "example": "35ef8dd5459bf5f08d44cb278bf07cd4" + "example": "3de4aa80c8c8822ea10d156a6f58d6f7" } } } @@ -14385,131 +12740,101 @@ } ] }, - "Country": { + "Currency": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "addressFormat" + "factor", + "symbol", + "isoCode", + "itemRounding", + "totalRounding", + "shortName", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "factor": { + "description": "Currency exchange rate.", + "type": "number", + "format": "float" }, - "iso": { - "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", + "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", "type": "string" }, - "position": { - "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", - "type": "integer", - "format": "int64" - }, - "active": { - "description": "When boolean value is `true`, the country is available for selection in the storefront.", - "type": "boolean" - }, - "shippingAvailable": { - "description": "The shipping availability for a country is enabled when boolean value is `true`.", - "type": "boolean" - }, - "iso3": { - "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", + "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", "type": "string" }, - "displayStateInRegistration": { - "description": "The country's state is displayed in the address when boolean value is `true`.", - "type": "boolean" + "shortName": { + "type": "string" }, - "forceStateInRegistration": { - "description": "State details in the address are force included when boolean value is `true`.", - "type": "boolean" + "name": { + "type": "string" }, - "checkVatIdPattern": { - "description": "Verify if VAT ID is valid or not.", - "type": "boolean" + "position": { + "description": "The order of the tabs for multiple currencies defined.", + "type": "integer", + "format": "int64" }, - "vatIdRequired": { - "description": "Set to true, if VAT ID is to be made mandatory.", + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "vatIdPattern": { - "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", - "type": "string" + "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", + "type": "number", + "format": "float" }, "customFields": { "type": "object" }, - "customerTax": { + "itemRounding": { "required": [ - "enabled", - "currencyId", - "amount" + "decimals", + "interval", + "roundForNet" ], "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" + "decimals": { + "type": "integer", + "format": "int64" }, - "amount": { + "interval": { "type": "number", "format": "float" + }, + "roundForNet": { + "type": "boolean" } }, "type": "object" }, - "companyTax": { + "totalRounding": { "required": [ - "enabled", - "currencyId", - "amount" + "decimals", + "interval", + "roundForNet" ], "properties": { - "enabled": { - "type": "boolean" - }, - "currencyId": { - "type": "string" + "decimals": { + "type": "integer", + "format": "int64" }, - "amount": { + "interval": { "type": "number", "format": "float" + }, + "roundForNet": { + "type": "boolean" } }, "type": "object" }, - "postalCodeRequired": { - "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", - "type": "boolean" - }, - "checkPostalCodePattern": { - "description": "Verify for valid postal code pattern.", - "type": "boolean" - }, - "checkAdvancedPostalCodePattern": { - "description": "Verify for advanced postal code pattern.", - "type": "boolean" - }, - "advancedPostalCodePattern": { - "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", - "type": "string" - }, - "addressFormat": { - "type": "object" - }, - "defaultPostalCodePattern": { - "description": "Default pattern of postal or zip code.", - "type": "string" - }, - "isEu": { - "type": "boolean" - }, "createdAt": { "type": "string", "format": "date-time", @@ -14523,44 +12848,43 @@ "translated": { "type": "object" }, - "states": { - "description": "States/provinces/regions within the country", + "salesChannelDefaultAssignments": { "type": "array", "items": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/SalesChannel" } }, - "customerAddresses": { + "orders": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/Order" } }, - "orderAddresses": { + "salesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/SalesChannel" } }, - "salesChannelDefaultAssignments": { + "salesChannelDomains": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/SalesChannelDomain" } }, - "salesChannels": { + "promotionDiscountPrices": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } }, - "taxRules": { + "productExports": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/ProductExport" } }, - "currencyCountryRoundings": { + "countryRoundings": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCountryRounding" @@ -14569,8 +12893,8 @@ }, "type": "object" }, - "CountryStateJsonApi": { - "description": "Added since version: 6.0.0.0", + "CurrencyCountryRoundingJsonApi": { + "description": "Added since version: 6.4.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -14578,37 +12902,64 @@ { "required": [ "id", + "currencyId", "countryId", - "shortCode", - "name" + "itemRounding", + "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { - "description": "Unique identity of the country.", + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shortCode": { - "description": "An abbreviation for the country's state.", - "type": "string" - }, - "name": { - "type": "string" - }, - "position": { - "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", - "type": "integer", - "format": "int64" + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "active": { - "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", - "type": "boolean" + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" }, - "customFields": { + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, "type": "object" }, "createdAt": { @@ -14621,12 +12972,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "country": { + "currency": { "properties": { "links": { "type": "object", @@ -14634,7 +12982,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/country" + "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/currency" } } }, @@ -14643,19 +12991,19 @@ "properties": { "type": { "type": "string", - "example": "country" + "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, - "customerAddresses": { + "country": { "properties": { "links": { "type": "object", @@ -14663,54 +13011,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/customerAddresses" + "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/country" } } }, "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": { "type": "string", - "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/orderAddresses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_address" - }, - "id": { - "type": "string", - "example": "c3182f0dc0cc20b4982616d3e0221747" - } + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } @@ -14725,41 +13040,68 @@ } ] }, - "CountryState": { - "description": "Added since version: 6.0.0.0", + "CurrencyCountryRounding": { + "description": "Added since version: 6.4.0.0", "required": [ "id", + "currencyId", "countryId", - "shortCode", - "name" + "itemRounding", + "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { - "description": "Unique identity of the country.", + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shortCode": { - "description": "An abbreviation for the country's state.", - "type": "string" - }, - "name": { - "type": "string" - }, - "position": { - "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", - "type": "integer", - "format": "int64" + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "active": { - "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", - "type": "boolean" + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" }, - "customFields": { + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, "type": "object" }, "createdAt": { @@ -14772,29 +13114,17 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "currency": { + "$ref": "#/components/schemas/Currency" }, "country": { "$ref": "#/components/schemas/Country" - }, - "customerAddresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } - }, - "orderAddresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } } }, "type": "object" }, - "CurrencyJsonApi": { - "description": "Added since version: 6.0.0.0", + "CustomEntityJsonApi": { + "description": "Added since version: 6.4.9.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -14802,96 +13132,53 @@ { "required": [ "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "shortName", - "name" + "name", + "fields" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "factor": { - "description": "Currency exchange rate.", - "type": "number", - "format": "float" - }, - "symbol": { - "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", + "name": { + "description": "Unique name of the entity.", "type": "string" }, - "isoCode": { - "description": "Standard international three digit code to represent currency. For example, USD.", - "type": "string" + "fields": { + "type": "object" }, - "shortName": { - "type": "string" + "flags": { + "type": "object" }, - "name": { - "type": "string" + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "position": { - "description": "The order of the tabs for multiple currencies defined.", - "type": "integer", - "format": "int64" + "pluginId": { + "description": "Unique identity of plugin.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "isSystemDefault": { + "cmsAware": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "taxFreeFrom": { - "description": "The value from which the tax must be exempted.", - "type": "number", - "format": "float" + "storeApiAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" }, - "customFields": { - "type": "object" + "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", + "type": "boolean" }, - "itemRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", + "type": "string" }, - "totalRounding": { - "required": [ - "decimals", - "interval", - "roundForNet" - ], - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "deletedAt": { + "type": "string", + "format": "date-time" }, "createdAt": { "type": "string", @@ -14902,13 +13189,141 @@ "type": "string", "format": "date-time", "readOnly": true + } + }, + "type": "object" + } + ] + }, + "CustomEntity": { + "description": "Added since version: 6.4.9.0", + "required": [ + "id", + "name", + "fields" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of the entity.", + "type": "string" + }, + "fields": { + "type": "object" + }, + "flags": { + "type": "object" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pluginId": { + "description": "Unique identity of plugin.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "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": { + "description": "Parameter that indicates the areas in which the custom field is supported.", + "type": "boolean" + }, + "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", + "type": "string" + }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "CustomFieldJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "translated": { + "name": { + "description": "Unique name of a custom field.", + "type": "string" + }, + "type": { + "description": "Custom field type can be selection, media , etc", + "type": "string" + }, + "config": { "type": "object" }, + "active": { + "description": "When boolean value is `true`, the custom field is enabled for use.", + "type": "boolean" + }, + "customFieldSetId": { + "description": "Unique identity of customFieldSet.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "allowCustomerWrite": { + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", + "type": "boolean" + }, + "allowCartExpose": { + "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", + "type": "boolean" + }, + "storeApiAware": { + "type": "boolean" + }, + "includeInSearch": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, "relationships": { "properties": { - "salesChannelDefaultAssignments": { + "customFieldSet": { "properties": { "links": { "type": "object", @@ -14916,30 +13331,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDefaultAssignments" + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/customFieldSet" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "df17e58b74fa5cb09c5e84f3b37141e1" } } } }, "type": "object" }, - "orders": { + "productSearchConfigFields": { "properties": { "links": { "type": "object", @@ -14947,7 +13360,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/orders" + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/productSearchConfigFields" } } }, @@ -14958,50 +13371,148 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "product_search_config_field" }, "id": { "type": "string", - "example": "12c500ed0b7879105fb46af0f246be87" + "example": "ae6a70432f71d6905502769f184399b1" } } } } }, "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": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomField": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of a custom field.", + "type": "string" + }, + "type": { + "description": "Custom field type can be selection, media , etc", + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "description": "When boolean value is `true`, the custom field is enabled for use.", + "type": "boolean" + }, + "customFieldSetId": { + "description": "Unique identity of customFieldSet.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "allowCustomerWrite": { + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", + "type": "boolean" + }, + "allowCartExpose": { + "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", + "type": "boolean" + }, + "storeApiAware": { + "type": "boolean" + }, + "includeInSearch": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFieldSet": { + "$ref": "#/components/schemas/CustomFieldSet" + }, + "productSearchConfigFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + }, + "type": "object" + }, + "CustomFieldSetJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of a custom field set.", + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "description": "When boolean value is `true`, the custom field set is enabled for use.", + "type": "boolean" + }, + "global": { + "description": "When set to `true`, the custom field set can be used across all sales channels.", + "type": "boolean" + }, + "position": { + "description": "The order of the tabs of your defined custom field set to be displayed.", + "type": "integer", + "format": "int64" + }, + "appId": { + "description": "Unique identity of an app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customFields": { "properties": { "links": { "type": "object", @@ -15009,7 +13520,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDomains" + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/customFields" } } }, @@ -15020,11 +13531,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_domain" + "example": "custom_field" }, "id": { "type": "string", - "example": "b60ab8d110194bfe34ef9928ba48ab6d" + "example": "4e252ff73243c27b4df9002e452fc6a7" } } } @@ -15032,7 +13543,7 @@ }, "type": "object" }, - "promotionDiscountPrices": { + "relations": { "properties": { "links": { "type": "object", @@ -15040,7 +13551,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/promotionDiscountPrices" + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/relations" } } }, @@ -15051,11 +13562,11 @@ "properties": { "type": { "type": "string", - "example": "promotion_discount_prices" + "example": "custom_field_set_relation" }, "id": { "type": "string", - "example": "325723473ecab76b0f45e1554513f779" + "example": "06c5b10273a69992d8c6933e294909fa" } } } @@ -15063,7 +13574,7 @@ }, "type": "object" }, - "productExports": { + "products": { "properties": { "links": { "type": "object", @@ -15071,7 +13582,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/productExports" + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/products" } } }, @@ -15082,11 +13593,11 @@ "properties": { "type": { "type": "string", - "example": "product_export" + "example": "product" }, "id": { "type": "string", - "example": "2cd8793787cda582174c0fc329fbc377" + "example": "86024cad1e83101d97359d7351051156" } } } @@ -15094,7 +13605,7 @@ }, "type": "object" }, - "countryRoundings": { + "app": { "properties": { "links": { "type": "object", @@ -15102,23 +13613,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/countryRoundings" + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/app" } } }, "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": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } @@ -15133,16 +13642,10 @@ } ] }, - "Currency": { + "CustomFieldSet": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "shortName", "name" ], "properties": { @@ -15150,83 +13653,30 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "factor": { - "description": "Currency exchange rate.", - "type": "number", - "format": "float" - }, - "symbol": { - "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", + "name": { + "description": "Unique name of a custom field set.", "type": "string" }, - "isoCode": { - "description": "Standard international three digit code to represent currency. For example, USD.", - "type": "string" + "config": { + "type": "object" }, - "shortName": { - "type": "string" + "active": { + "description": "When boolean value is `true`, the custom field set is enabled for use.", + "type": "boolean" }, - "name": { - "type": "string" + "global": { + "description": "When set to `true`, the custom field set can be used across all sales channels.", + "type": "boolean" }, "position": { - "description": "The order of the tabs for multiple currencies defined.", + "description": "The order of the tabs of your defined custom field set to be displayed.", "type": "integer", "format": "int64" }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "taxFreeFrom": { - "description": "The value from which the tax must be exempted.", - "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" + "appId": { + "description": "Unique identity of an app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -15238,56 +13688,32 @@ "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": { + "customFields": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/CustomField" } }, - "promotionDiscountPrices": { + "relations": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/CustomFieldSetRelation" } }, - "productExports": { + "products": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/Product" } }, - "countryRoundings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "CurrencyCountryRoundingJsonApi": { - "description": "Added since version: 6.4.0.0", + "CustomFieldSetRelationJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -15295,65 +13721,22 @@ { "required": [ "id", - "currencyId", - "countryId", - "itemRounding", - "totalRounding" + "customFieldSetId", + "entityName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { + "customFieldSetId": { + "description": "Unique identity of a custom field set.", "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" + "entityName": { + "description": "Name of the entity.", + "type": "string" }, "createdAt": { "type": "string", @@ -15367,36 +13750,7 @@ }, "relationships": { "properties": { - "currency": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/currency" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "currency" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" - } - } - } - }, - "type": "object" - }, - "country": { + "customFieldSet": { "properties": { "links": { "type": "object", @@ -15404,7 +13758,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/country" + "example": "/custom-field-set-relation/9686e510825802f328b6a861ccaa977e/customFieldSet" } } }, @@ -15413,12 +13767,12 @@ "properties": { "type": { "type": "string", - "example": "country" + "example": "custom_field_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "example": "df17e58b74fa5cb09c5e84f3b37141e1" } } } @@ -15433,69 +13787,26 @@ } ] }, - "CurrencyCountryRounding": { - "description": "Added since version: 6.4.0.0", + "CustomFieldSetRelation": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "currencyId", - "countryId", - "itemRounding", - "totalRounding" + "customFieldSetId", + "entityName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { + "customFieldSetId": { + "description": "Unique identity of a custom field set.", "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" + "entityName": { + "description": "Name of the entity.", + "type": "string" }, "createdAt": { "type": "string", @@ -15507,17 +13818,14 @@ "format": "date-time", "readOnly": true }, - "currency": { - "$ref": "#/components/schemas/Currency" - }, - "country": { - "$ref": "#/components/schemas/Country" + "customFieldSet": { + "$ref": "#/components/schemas/CustomFieldSet" } }, "type": "object" }, - "CustomEntityJsonApi": { - "description": "Added since version: 6.4.9.0", + "CustomerJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -15525,184 +13833,185 @@ { "required": [ "id", - "name", - "fields" + "groupId", + "salesChannelId", + "languageId", + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", + "firstName", + "lastName", + "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Unique name of the entity.", - "type": "string" + "groupId": { + "description": "Unique identity of customer group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "fields": { - "type": "object" + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "flags": { - "type": "object" + "languageId": { + "description": "Unique identity of language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "appId": { - "description": "Unique identity of app.", + "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "pluginId": { - "description": "Unique identity of plugin.", + "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsAware": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" + "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "storeApiAware": { - "description": "Runtime field, cannot be used as part of the criteria.", + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customerNumber": { + "description": "Unique number assigned to identity a customer.", + "type": "string" + }, + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "email": { + "description": "Email ID of the customer.", + "type": "string" + }, + "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", + "type": "string" + }, + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "type": "string" + }, + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" + }, + "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", "type": "boolean" }, - "customFieldsAware": { - "description": "Parameter that indicates the areas in which the custom field is supported.", + "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", "type": "boolean" }, - "labelProperty": { - "description": "Specifies which property or attribute of the custom entity is used.", + "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", + "type": "string", + "format": "date-time" + }, + "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", + "type": "string", + "format": "date-time" + }, + "hash": { + "description": "Customer registration double opt-in hash for confirming the customer account.", "type": "string" }, - "deletedAt": { + "guest": { + "description": "Boolean value is `true` if it is to be a guest account.", + "type": "boolean" + }, + "firstLogin": { + "description": "To capture date and time of customer's first login.", "type": "string", "format": "date-time" }, - "createdAt": { + "lastLogin": { + "description": "To capture date and time of customer's last login.", "type": "string", - "format": "date-time", - "readOnly": true + "format": "date-time" }, - "updatedAt": { + "birthday": { + "description": "To capture customer's birthday details.", + "type": "string" + }, + "lastOrderDate": { + "description": "Captures last order date.", "type": "string", "format": "date-time", "readOnly": true - } - }, - "type": "object" - } - ] - }, - "CustomEntity": { - "description": "Added since version: 6.4.9.0", - "required": [ - "id", - "name", - "fields" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Unique name of the entity.", - "type": "string" - }, - "fields": { - "type": "object" - }, - "flags": { - "type": "object" - }, - "appId": { - "description": "Unique identity of app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "pluginId": { - "description": "Unique identity of plugin.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "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": { - "description": "Parameter that indicates the areas in which the custom field is supported.", - "type": "boolean" - }, - "labelProperty": { - "description": "Specifies which property or attribute of the custom entity is used.", - "type": "string" - }, - "deletedAt": { - "type": "string", - "format": "date-time" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - }, - "CustomFieldJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "type" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "name": { - "description": "Unique name of a custom field.", - "type": "string" + "orderCount": { + "description": "Captures the number of orders placed.", + "type": "integer", + "format": "int64", + "readOnly": true }, - "type": { - "description": "Custom field type can be selection, media , etc", - "type": "string" + "orderTotalAmount": { + "description": "Sum of total amount to be paid.", + "type": "number", + "format": "float", + "readOnly": true }, - "config": { + "reviewCount": { + "description": "Number of reviews the customer has given.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customFields": { "type": "object" }, - "active": { - "description": "When boolean value is `true`, the custom field is enabled for use.", - "type": "boolean" + "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", + "type": "string" }, - "customFieldSetId": { - "description": "Unique identity of customFieldSet.", + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "requestedGroupId": { + "description": "Unique identity of requested group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "allowCustomerWrite": { - "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", - "type": "boolean" - }, - "allowCartExpose": { - "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", - "type": "boolean" + "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "storeApiAware": { - "type": "boolean" + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "includeInSearch": { - "type": "boolean" + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -15714,9 +14023,9 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "extensions": { "properties": { - "customFieldSet": { + "salesChannelTracking": { "properties": { "links": { "type": "object", @@ -15724,7 +14033,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/customFieldSet" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" } } }, @@ -15733,19 +14042,19 @@ "properties": { "type": { "type": "string", - "example": "custom_field_set" + "example": "sales_channel_tracking_customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "df17e58b74fa5cb09c5e84f3b37141e1" + "example": "0be2acfa806308827a1893fe389a7c8b" } } } }, "type": "object" }, - "productSearchConfigFields": { + "attendee": { "properties": { "links": { "type": "object", @@ -15753,7 +14062,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/productSearchConfigFields" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/attendee" } } }, @@ -15764,11 +14073,11 @@ "properties": { "type": { "type": "string", - "example": "product_search_config_field" + "example": "dsr_appointment_attendee" }, "id": { "type": "string", - "example": "ae6a70432f71d6905502769f184399b1" + "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" } } } @@ -15778,134 +14087,11 @@ } }, "type": "object" - } - }, - "type": "object" - } - ] - }, - "CustomField": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name", - "type" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Unique name of a custom field.", - "type": "string" - }, - "type": { - "description": "Custom field type can be selection, media , etc", - "type": "string" - }, - "config": { - "type": "object" - }, - "active": { - "description": "When boolean value is `true`, the custom field is enabled for use.", - "type": "boolean" - }, - "customFieldSetId": { - "description": "Unique identity of customFieldSet.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "allowCustomerWrite": { - "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", - "type": "boolean" - }, - "allowCartExpose": { - "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", - "type": "boolean" - }, - "storeApiAware": { - "type": "boolean" - }, - "includeInSearch": { - "type": "boolean" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "customFieldSet": { - "$ref": "#/components/schemas/CustomFieldSet" - }, - "productSearchConfigFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - }, - "type": "object" - }, - "CustomFieldSetJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Unique name of a custom field set.", - "type": "string" - }, - "config": { - "type": "object" - }, - "active": { - "description": "When boolean value is `true`, the custom field set is enabled for use.", - "type": "boolean" - }, - "global": { - "description": "When set to `true`, the custom field set can be used across all sales channels.", - "type": "boolean" - }, - "position": { - "description": "The order of the tabs of your defined custom field set to be displayed.", - "type": "integer", - "format": "int64" - }, - "appId": { - "description": "Unique identity of an app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true }, "relationships": { "properties": { - "customFields": { + "group": { + "description": "Customer group determining pricing and permissions", "properties": { "links": { "type": "object", @@ -15913,30 +14099,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/customFields" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/group" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_field" - }, - "id": { - "type": "string", - "example": "4e252ff73243c27b4df9002e452fc6a7" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "db0f6f37ebeb6ea09489124345af2a45" } } } }, "type": "object" }, - "relations": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -15944,30 +14128,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/relations" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_field_set_relation" - }, - "id": { - "type": "string", - "example": "06c5b10273a69992d8c6933e294909fa" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "products": { + "language": { + "description": "Preferred language for customer communication", "properties": { "links": { "type": "object", @@ -15975,30 +14158,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/products" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/language" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "86024cad1e83101d97359d7351051156" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "app": { + "lastPaymentMethod": { + "description": "Last used payment method by the customer", "properties": { "links": { "type": "object", @@ -16006,7 +14188,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/app" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/lastPaymentMethod" } } }, @@ -16015,135 +14197,20 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "bb083200005a374b86f6f5fbbff6f0e0" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CustomFieldSet": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Unique name of a custom field set.", - "type": "string" - }, - "config": { - "type": "object" - }, - "active": { - "description": "When boolean value is `true`, the custom field set is enabled for use.", - "type": "boolean" - }, - "global": { - "description": "When set to `true`, the custom field set can be used across all sales channels.", - "type": "boolean" - }, - "position": { - "description": "The order of the tabs of your defined custom field set to be displayed.", - "type": "integer", - "format": "int64" - }, - "appId": { - "description": "Unique identity of an app.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "customFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomField" - } - }, - "relations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "app": { - "$ref": "#/components/schemas/App" - } - }, - "type": "object" - }, - "CustomFieldSetRelationJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "customFieldSetId", - "entityName" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFieldSetId": { - "description": "Unique identity of a custom field set.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entityName": { - "description": "Name of the entity.", - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "customFieldSet": { + }, + "defaultBillingAddress": { + "description": "Default billing address for the customer", "properties": { "links": { "type": "object", @@ -16151,7 +14218,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set-relation/9686e510825802f328b6a861ccaa977e/customFieldSet" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultBillingAddress" } } }, @@ -16160,265 +14227,20 @@ "properties": { "type": { "type": "string", - "example": "custom_field_set" + "example": "customer_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "df17e58b74fa5cb09c5e84f3b37141e1" + "example": "263d0f6e5d8d71fc4c288736f7c90990" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CustomFieldSetRelation": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "customFieldSetId", - "entityName" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFieldSetId": { - "description": "Unique identity of a custom field set.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entityName": { - "description": "Name of the entity.", - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "customFieldSet": { - "$ref": "#/components/schemas/CustomFieldSet" - } - }, - "type": "object" - }, - "CustomerJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "groupId", - "salesChannelId", - "languageId", - "defaultBillingAddressId", - "defaultShippingAddressId", - "customerNumber", - "firstName", - "lastName", - "email" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "groupId": { - "description": "Unique identity of customer group.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "description": "Unique identity of sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "description": "Unique identity of language.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "lastPaymentMethodId": { - "description": "Unique identity of previous payment method.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultBillingAddressId": { - "description": "Unique identity of default billing address.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultShippingAddressId": { - "description": "Unique identity of default shipping address.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "customerNumber": { - "description": "Unique number assigned to identity a customer.", - "type": "string" - }, - "salutationId": { - "description": "Unique identity of salutation.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "description": "First name of the customer.", - "type": "string" - }, - "lastName": { - "description": "Last name of the customer.", - "type": "string" - }, - "email": { - "description": "Email ID of the customer.", - "type": "string" - }, - "title": { - "description": "Titles or honorifics like Mr, Mrs, etc.", - "type": "string" - }, - "affiliateCode": { - "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", - "type": "string" - }, - "campaignCode": { - "description": "A campaign code is the globally unique identifier for a campaign.", - "type": "string" - }, - "active": { - "description": "To keep the status of the customer active, the boolean value is set to `true`.", - "type": "boolean" - }, - "doubleOptInRegistration": { - "description": "Set to `true` to allow user subscriptions to an email marketing list.", - "type": "boolean" - }, - "doubleOptInEmailSentDate": { - "description": "Date and time when the double opt-in email was sent.", - "type": "string", - "format": "date-time" - }, - "doubleOptInConfirmDate": { - "description": "Date and time when the double opt-in email was confirmed.", - "type": "string", - "format": "date-time" - }, - "hash": { - "description": "Customer registration double opt-in hash for confirming the customer account.", - "type": "string" - }, - "guest": { - "description": "Boolean value is `true` if it is to be a guest account.", - "type": "boolean" - }, - "firstLogin": { - "description": "To capture date and time of customer's first login.", - "type": "string", - "format": "date-time" - }, - "lastLogin": { - "description": "To capture date and time of customer's last login.", - "type": "string", - "format": "date-time" - }, - "birthday": { - "description": "To capture customer's birthday details.", - "type": "string" - }, - "lastOrderDate": { - "description": "Captures last order date.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "orderCount": { - "description": "Captures the number of orders placed.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "orderTotalAmount": { - "description": "Sum of total amount to be paid.", - "type": "number", - "format": "float", - "readOnly": true - }, - "reviewCount": { - "description": "Number of reviews the customer has given.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "customFields": { - "type": "object" - }, - "remoteAddress": { - "description": "Anonymous IP address of the customer for last session.", - "type": "string" - }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "requestedGroupId": { - "description": "Unique identity of requested group.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "boundSalesChannelId": { - "description": "Unique identity of bonus sales channel.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "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": { - "salesChannelTracking": { + }, + "activeBillingAddress": { + "description": "Currently active billing address in the session", "properties": { "links": { "type": "object", @@ -16426,7 +14248,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeBillingAddress" } } }, @@ -16435,19 +14257,20 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_tracking_customer" + "example": "customer_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "0be2acfa806308827a1893fe389a7c8b" + "example": "1a4362407b6a71fa80952dcd4ba7feb3" } } } }, "type": "object" }, - "attendee": { + "defaultShippingAddress": { + "description": "Default shipping address for the customer", "properties": { "links": { "type": "object", @@ -16455,36 +14278,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/attendee" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultShippingAddress" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "dsr_appointment_attendee" - }, - "id": { - "type": "string", - "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8218c377171d06883caea7e2baf67f31" } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "group": { - "description": "Customer group determining pricing and permissions", + }, + "activeShippingAddress": { + "description": "Currently active shipping address in the session", "properties": { "links": { "type": "object", @@ -16492,7 +14308,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/group" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeShippingAddress" } } }, @@ -16501,19 +14317,20 @@ "properties": { "type": { "type": "string", - "example": "customer_group" + "example": "customer_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "db0f6f37ebeb6ea09489124345af2a45" + "example": "f6e2f5dd29b543b8547e30d2d71a6974" } } } }, "type": "object" }, - "salesChannel": { + "salutation": { + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)", "properties": { "links": { "type": "object", @@ -16521,7 +14338,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannel" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salutation" } } }, @@ -16530,20 +14347,20 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" }, - "language": { - "description": "Preferred language for customer communication", + "addresses": { + "description": "All addresses saved for the customer", "properties": { "links": { "type": "object", @@ -16551,29 +14368,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/language" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/addresses" } } }, "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": "customer_address" + }, + "id": { + "type": "string", + "example": "963e3a2fe559e393bad631f3dc686f69" + } } } } }, "type": "object" }, - "lastPaymentMethod": { - "description": "Last used payment method by the customer", + "orderCustomers": { "properties": { "links": { "type": "object", @@ -16581,29 +14399,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/lastPaymentMethod" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/orderCustomers" } } }, "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": "order_customer" + }, + "id": { + "type": "string", + "example": "1e7dbe7e3bcb48d233fd80588f54c980" + } } } } }, "type": "object" }, - "defaultBillingAddress": { - "description": "Default billing address for the customer", + "tags": { + "description": "Tags assigned to the customer for organization and segmentation", "properties": { "links": { "type": "object", @@ -16611,29 +14431,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultBillingAddress" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/tags" } } }, "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": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } } } } }, "type": "object" }, - "activeBillingAddress": { - "description": "Currently active billing address in the session", + "promotions": { "properties": { "links": { "type": "object", @@ -16641,221 +14462,7 @@ "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": { - "description": "Default shipping address for the customer", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultShippingAddress" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8218c377171d06883caea7e2baf67f31" - } - } - } - }, - "type": "object" - }, - "activeShippingAddress": { - "description": "Currently active shipping address in the session", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeShippingAddress" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f6e2f5dd29b543b8547e30d2d71a6974" - } - } - } - }, - "type": "object" - }, - "salutation": { - "description": "Customer salutation (e.g., Mr., Mrs., Ms.)", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salutation" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "salutation" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" - } - } - } - }, - "type": "object" - }, - "addresses": { - "description": "All addresses saved for the customer", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/addresses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "example": "963e3a2fe559e393bad631f3dc686f69" - } - } - } - } - }, - "type": "object" - }, - "orderCustomers": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/orderCustomers" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_customer" - }, - "id": { - "type": "string", - "example": "1e7dbe7e3bcb48d233fd80588f54c980" - } - } - } - } - }, - "type": "object" - }, - "tags": { - "description": "Tags assigned to the customer for organization and segmentation", - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "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": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/promotions" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/promotions" } } }, @@ -25372,7 +22979,8 @@ "type": "object" }, "templateData": { - "type": "object" + "type": "object", + "deprecated": true }, "createdAt": { "type": "string", @@ -25454,7 +23062,8 @@ "type": "object" }, "templateData": { - "type": "object" + "type": "object", + "deprecated": true }, "createdAt": { "type": "string", @@ -40103,6 +37712,10 @@ "description": "To configure whether the field can be used for searching.", "type": "boolean" }, + "useExactSubfield": { + "description": "To configure whether exact match queries should target the exact subfield, which uses the whitespace analyzer (lowercased, whitespace-tokenised) and bypasses the language analyzer (no stemming, no stop-word removal, no compound decomposition).", + "type": "boolean" + }, "ranking": { "description": "Search ranking.", "type": "integer", @@ -40220,6 +37833,10 @@ "description": "To configure whether the field can be used for searching.", "type": "boolean" }, + "useExactSubfield": { + "description": "To configure whether exact match queries should target the exact subfield, which uses the whitespace analyzer (lowercased, whitespace-tokenised) and bypasses the language analyzer (no stemming, no stop-word removal, no compound decomposition).", + "type": "boolean" + }, "ranking": { "description": "Search ranking.", "type": "integer", @@ -54318,259 +51935,48 @@ } } }, - "infoConfigResponse": { + "MeasurementUnits": { "type": "object", + "description": "Configuration of the measurement system", "properties": { - "version": { - "type": "string", - "description": "Shopware version." - }, - "shopId": { - "type": "string", - "description": "Unique shop identifier." - }, - "versionRevision": { + "system": { "type": "string", - "description": "Shopware version revision (build hash/revision)." - }, - "adminWorker": { - "type": "object", - "description": "Admin worker feature flags and transport configuration.", - "properties": { - "enableAdminWorker": { - "type": "boolean", - "description": "Whether the admin background worker is enabled." - }, - "enableQueueStatsWorker": { - "type": "boolean", - "description": "Whether the queue statistics worker is enabled. Deprecated: This property will be removed in v6.8.0. The increment-based message queue statistics are deprecated.", - "deprecated": true - }, - "enableNotificationWorker": { - "type": "boolean", - "description": "Whether the notification worker is enabled." - }, - "transports": { - "type": "array", - "description": "Configured Symfony Messenger transports used by the admin workers.", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false - }, - "bundles": { - "type": "object", - "description": "Active extension assets (plugins & apps) keyed by technical name.", - "additionalProperties": { - "oneOf": [ - { - "type": "object", - "description": "Plugin bundle asset descriptor.", - "properties": { - "type": { - "type": "string", - "enum": [ - "plugin" - ] - }, - "css": { - "type": "array", - "items": { - "type": "string", - "description": "URL to a CSS asset." - } - }, - "js": { - "type": "array", - "items": { - "type": "string", - "description": "URL to a JS asset." - } - }, - "baseUrl": { - "type": [ - "string", - "null" - ], - "description": "Base URL to a (micro frontend) admin entry point, if provided." - } - }, - "required": [ - "type" - ], - "additionalProperties": false - }, - { - "type": "object", - "description": "App bundle descriptor.", - "properties": { - "type": { - "type": "string", - "enum": [ - "app" - ] - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "integrationId": { - "type": "string", - "description": "Lowercase hex integration id." - }, - "baseUrl": { - "type": "string" - }, - "version": { - "type": "string" - }, - "permissions": { - "type": "object", - "description": "Grouped privileges: key = privilege scope, value = list of entities.", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "css": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional CSS assets if provided." - }, - "js": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional JS assets if provided." - } - }, - "required": [ - "type", - "name", - "active", - "integrationId", - "baseUrl", - "version", - "permissions" - ], - "additionalProperties": false - } - ] - } + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." }, - "settings": { + "units": { "type": "object", - "description": "Selected environment and feature settings consumed by the administration.", + "description": "Units used in the measurement system.", "properties": { - "enableUrlFeature": { - "type": "boolean", - "description": "State of the URL upload feature." - }, - "appUrlReachable": { - "type": "boolean", - "description": "Whether configured APP_URL is externally reachable." - }, - "appsRequireAppUrl": { - "type": "boolean", - "description": "True if at least one installed app requires a reachable APP_URL." - }, - "firstMigrationDate": { - "type": [ - "string", - "null" + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" ], - "description": "Timestamp of the first executed migration in ISO-8601 UTC format, used for Product Analytics consent eligibility." - }, - "private_allowed_extensions": { - "type": "array", - "description": "Whitelisted file extensions for private filesystem uploads.", - "items": { - "type": "string" - } - }, - "enableHtmlSanitizer": { - "type": "boolean", - "description": "Whether HTML sanitizer is enabled." - }, - "enableStagingMode": { - "type": "boolean", - "description": "Whether staging mode banner is enabled." - }, - "disableExtensionManagement": { - "type": "boolean", - "description": "True if runtime extension management is disabled." + "default": "mm", + "description": "Unit of length." }, - "presignedUploadSupported": { - "type": "boolean", - "description": "Whether presigned S3 upload is available. True when presigned upload is enabled and an S3 filesystem is configured." + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." } - }, - "required": [ - "firstMigrationDate" - ], - "additionalProperties": false - }, - "inAppPurchases": { - "type": "array", - "description": "In-app purchase meta data (structure may vary).", - "items": { - "type": "object", - "description": "Purchase entry.", - "additionalProperties": true } } - }, - "required": [ - "version", - "shopId", - "versionRevision", - "adminWorker", - "bundles", - "settings", - "inAppPurchases" - ], - "additionalProperties": false - }, - "MediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Media entity ID" - }, - "ExternalThumbnail": { - "type": "object", - "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", - "required": [ - "url", - "width", - "height" - ], - "properties": { - "url": { - "type": "string", - "description": "Absolute HTTP/HTTPS URL of the thumbnail", - "example": "https://cdn.example.com/image-200x200.jpg" - }, - "width": { - "type": "integer", - "exclusiveMinimum": 0, - "description": "Width of the thumbnail in pixels", - "example": 200 - }, - "height": { - "type": "integer", - "exclusiveMinimum": 0, - "description": "Height of the thumbnail in pixels", - "example": 200 - } } }, "Criteria": { @@ -54697,7 +52103,7 @@ } }, "Includes": { - "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. To return a DAL extension, list the extension by its name (for example `myExtension`); the `extensions` wrapper is then kept automatically. Listing the keyword `extensions` returns all extensions.", "type": "object", "additionalProperties": { "type": "array", @@ -54707,7 +52113,7 @@ } }, "Excludes": { - "description": "Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "description": "Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons. Use an extension name to remove a single extension, or the keyword `extensions` to remove all of them.", "type": "object", "additionalProperties": { "type": "array", @@ -55279,189 +52685,227 @@ "field" ] }, - "Price": { + "infoConfigResponse": { "type": "object", - "description": "Price object", "properties": { - "currencyId": { - "description": "Unique identity of the associated currency.", + "version": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "Gross price for the associated currency.", - "type": "number" - }, - "net": { - "description": "Net price for the associated currency.", - "type": "number" + "description": "Shopware version." }, - "linked": { - "description": "Whether gross and net prices are linked through the tax configuration.", - "type": "boolean" + "shopId": { + "type": "string", + "description": "Unique shop identifier." }, - "percentage": { - "description": "Discount percentage relative to the list price for the gross and net amounts. `null` when no list price is set.", - "type": [ - "object", - "null" - ], - "properties": { - "gross": { - "description": "Discount percentage relative to the gross list price.", - "type": "number" - }, - "net": { - "description": "Discount percentage relative to the net list price.", - "type": "number" - } - }, - "required": [ - "gross", - "net" - ] + "versionRevision": { + "type": "string", + "description": "Shopware version revision (build hash/revision)." }, - "listPrice": { - "description": "Reference list price for displaying discounts.", + "adminWorker": { "type": "object", + "description": "Admin worker feature flags and transport configuration.", "properties": { - "currencyId": { - "description": "Unique identity of the associated currency.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enableAdminWorker": { + "type": "boolean", + "description": "Whether the admin background worker is enabled." }, - "gross": { - "description": "Gross list price for the associated currency.", - "type": "number" + "enableQueueStatsWorker": { + "type": "boolean", + "description": "Whether the queue statistics worker is enabled. Deprecated: This property will be removed in v6.8.0. The increment-based message queue statistics are deprecated.", + "deprecated": true }, - "net": { - "description": "Net list price for the associated currency.", - "type": "number" + "enableNotificationWorker": { + "type": "boolean", + "description": "Whether the notification worker is enabled." }, - "linked": { - "description": "Whether gross and net list prices are linked through the tax configuration.", - "type": "boolean" + "transports": { + "type": "array", + "description": "Configured Symfony Messenger transports used by the admin workers.", + "items": { + "type": "string" + } } }, - "required": [ - "gross", - "net", - "linked" - ] + "additionalProperties": false }, - "regulationPrice": { - "description": "Reference price used for legal price disclosures.", + "bundles": { + "type": "object", + "description": "Active extension assets (plugins & apps) keyed by technical name.", + "additionalProperties": { + "oneOf": [ + { + "type": "object", + "description": "Plugin bundle asset descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "plugin" + ] + }, + "css": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a CSS asset." + } + }, + "js": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a JS asset." + } + }, + "baseUrl": { + "type": [ + "string", + "null" + ], + "description": "Base URL to a (micro frontend) admin entry point, if provided." + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "description": "App bundle descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "app" + ] + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "integrationId": { + "type": "string", + "description": "Lowercase hex integration id." + }, + "baseUrl": { + "type": "string" + }, + "version": { + "type": "string" + }, + "permissions": { + "type": "object", + "description": "Grouped privileges: key = privilege scope, value = list of entities.", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "css": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional CSS assets if provided." + }, + "js": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional JS assets if provided." + } + }, + "required": [ + "type", + "name", + "active", + "integrationId", + "baseUrl", + "version", + "permissions" + ], + "additionalProperties": false + } + ] + } + }, + "settings": { "type": "object", + "description": "Selected environment and feature settings consumed by the administration.", "properties": { - "currencyId": { - "description": "Unique identity of the associated currency.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enableUrlFeature": { + "type": "boolean", + "description": "State of the URL upload feature." }, - "gross": { - "description": "Gross regulation price for the associated currency.", - "type": "number" + "appUrlReachable": { + "type": "boolean", + "description": "Whether configured APP_URL is externally reachable." }, - "net": { - "description": "Net regulation price for the associated currency.", - "type": "number" + "appsRequireAppUrl": { + "type": "boolean", + "description": "True if at least one installed app requires a reachable APP_URL." }, - "linked": { - "description": "Whether gross and net regulation prices are linked through the tax configuration.", - "type": "boolean" + "firstMigrationDate": { + "type": [ + "string", + "null" + ], + "description": "Timestamp of the first executed migration in ISO-8601 UTC format, used for Product Analytics consent eligibility." + }, + "private_allowed_extensions": { + "type": "array", + "description": "Whitelisted file extensions for private filesystem uploads.", + "items": { + "type": "string" + } + }, + "enableHtmlSanitizer": { + "type": "boolean", + "description": "Whether HTML sanitizer is enabled." + }, + "enableStagingMode": { + "type": "boolean", + "description": "Whether staging mode banner is enabled." + }, + "disableExtensionManagement": { + "type": "boolean", + "description": "True if runtime extension management is disabled." + }, + "presignedUploadSupported": { + "type": "boolean", + "description": "Whether presigned S3 upload is available. True when presigned upload is enabled and an S3 filesystem is configured." } }, "required": [ - "gross", - "net", - "linked" - ] - } - }, - "required": [ - "currencyId", - "gross", - "net", - "linked" - ] - }, - "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" - } - } - } - } - }, - "MeasurementUnits": { - "type": "object", - "description": "Configuration of the measurement system", - "properties": { - "system": { - "type": "string", - "enum": [ - "metric", - "imperial" + "firstMigrationDate" ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + "additionalProperties": false }, - "units": { - "type": "object", - "description": "Units used in the measurement system.", - "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." - }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." - } + "inAppPurchases": { + "type": "array", + "description": "In-app purchase meta data (structure may vary).", + "items": { + "type": "object", + "description": "Purchase entry.", + "additionalProperties": true } } - } + }, + "required": [ + "version", + "shopId", + "versionRevision", + "adminWorker", + "bundles", + "settings", + "inAppPurchases" + ], + "additionalProperties": false }, "OAuthScopes": { "description": "OAuth scopes that should be requested.", @@ -55587,6 +53031,145 @@ } ] }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "Gross price for the associated currency.", + "type": "number" + }, + "net": { + "description": "Net price for the associated currency.", + "type": "number" + }, + "linked": { + "description": "Whether gross and net prices are linked through the tax configuration.", + "type": "boolean" + }, + "percentage": { + "description": "Discount percentage relative to the list price for the gross and net amounts. `null` when no list price is set.", + "type": [ + "object", + "null" + ], + "properties": { + "gross": { + "description": "Discount percentage relative to the gross list price.", + "type": "number" + }, + "net": { + "description": "Discount percentage relative to the net list price.", + "type": "number" + } + }, + "required": [ + "gross", + "net" + ] + }, + "listPrice": { + "description": "Reference list price for displaying discounts.", + "type": "object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "Gross list price for the associated currency.", + "type": "number" + }, + "net": { + "description": "Net list price for the associated currency.", + "type": "number" + }, + "linked": { + "description": "Whether gross and net list prices are linked through the tax configuration.", + "type": "boolean" + } + }, + "required": [ + "gross", + "net", + "linked" + ] + }, + "regulationPrice": { + "description": "Reference price used for legal price disclosures.", + "type": "object", + "properties": { + "currencyId": { + "description": "Unique identity of the associated currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "Gross regulation price for the associated currency.", + "type": "number" + }, + "net": { + "description": "Net regulation price for the associated currency.", + "type": "number" + }, + "linked": { + "description": "Whether gross and net regulation prices are linked through the tax configuration.", + "type": "boolean" + } + }, + "required": [ + "gross", + "net", + "linked" + ] + } + }, + "required": [ + "currencyId", + "gross", + "net", + "linked" + ] + }, + "MediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Media entity ID" + }, + "ExternalThumbnail": { + "type": "object", + "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", + "required": [ + "url", + "width", + "height" + ], + "properties": { + "url": { + "type": "string", + "description": "Absolute HTTP/HTTPS URL of the thumbnail", + "example": "https://cdn.example.com/image-200x200.jpg" + }, + "width": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Width of the thumbnail in pixels", + "example": 200 + }, + "height": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Height of the thumbnail in pixels", + "example": 200 + } + } + }, "flowBuilderActionsResponse": { "type": "array", "items": { @@ -55613,73 +53196,150 @@ } } }, - "PresentationCmsPage": { - "allOf": [ - { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - }, - { - "type": "object", - "properties": { - "pickedProductIds": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Product id" - } - }, - { - "type": "null" - } - ], - "description": "The product id is assigned to presentation if it's product listing or instant listing" + "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" } } } - ] + } }, - "CartError": { + "GetCartInsightsResponse": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "description": "Returns aggregations for the current carts within the appointment.", "properties": { - "items": { + "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": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the shown currency" + }, + "currencySymbol": { + "type": "string", + "description": "The currency symbol from the shown currency" + }, + "topProducts": { "type": "object", + "required": [ + "byQuantity", + "byRevenue" + ], "properties": { - "key": { - "type": "string" - }, - "level": { - "type": "number", - "enum": [ - 0, - 10, - 20 - ], - "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" - }, - "message": { - "type": "string" + "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" + } + }, + "required": [ + "productId", + "value" + ] + } }, - "messageKey": { - "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" + } + }, + "required": [ + "productId", + "value" + ] + } } } } - } - }, - "GetListBodyRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "Max amount of resources to be returned in a page" - }, - "page": { - "type": "integer", - "description": "The page to be returned" + }, + "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 + }, + { + "productId": "01ae0dee60ea48fdafaf881b96361d59", + "value": 1152.62 + }, + { + "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", + "value": 284.88 + } + ] } } }, @@ -55733,38 +53393,109 @@ } } }, - "CartPriceQuantity": { + "CalculatedPrice": { "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_quantity" - ] + "unitPrice": { + "type": "number" }, - "isCalculated": { - "type": "boolean" + "quantity": { + "type": "number" + }, + "rawTotal": { + "type": "number" + }, + "totalPrice": { + "type": "number" + }, + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] }, "listPrice": { - "$ref": "#/components/schemas/CartListPrice" + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] }, - "price": { + "positionPrice": { "type": "number" }, - "quantity": { + "netPrice": { "type": "number" }, "regulationPrice": { + "type": "object", "properties": { "price": { - "type": "number", - "format": "float" + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] } }, - "type": "object" + "nullable": true + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true + }, + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] }, "taxRules": { "type": "array", + "description": "Currently active tax rules and/or rates", "items": { "type": "object", "properties": { @@ -55777,76 +53508,46 @@ } } } - }, - "type": { - "type": "string" } }, "required": [ - "apiAlias" + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "referencePrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitPrice", + "positionPrice", + "netPrice", + "taxRules" ] }, - "CartDelivery": { + "CartListPrice": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "description": "", "properties": { - "deliveryDate": { - "type": "object", - "properties": { - "earliest": { - "type": "string", - "format": "date-time" - }, - "latest": { - "type": "string", - "format": "date-time" - } - } - }, - "location": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_shipping_location" - ] - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "address": { - "$ref": "#/components/schemas/CustomerAddress" - }, - "state": { - "$ref": "#/components/schemas/CountryState" - } - } + "discount": { + "type": "number" }, - "positions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDeliveryPosition" - } + "percentage": { + "type": "number" }, - "shippingCosts": { - "$ref": "#/components/schemas/CalculatedPrice" + "price": { + "type": "number" }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "apiAlias": { + "type": "string", + "enum": [ + "cart_list_price" + ] } - } - }, - "DynamicProductListingPageOpenedPayload": { + }, "required": [ - "page" - ], - "properties": { - "page": { - "type": "integer", - "description": "Current page position in the pagination" - } - } + "apiAlias" + ] }, "CartDeliveryInformation": { "type": "object", @@ -55906,468 +53607,296 @@ "apiAlias" ] }, - "JoinAppointmentResponse": { + "GuidePresentationStateResponse": { "type": "object", - "description": "Includes all data you will need to attend to a appointment.", "properties": { - "mercureSubscriberTopics": { - "type": "array", - "items": { - "type": "string", - "description": "mercure topic" + "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" }, - "description": "The topics to which the attendee/guide can subscribe for" + "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", + "broadcastMode": false, + "extensions": [] }, - "mercurePublisherTopic": { - "oneOf": [ - { - "type": "string" + "stateForGuides": { + "clients": [], + "inactiveClients": { + "2b4066cd37a341088e32a81e04a56817": { + "attendeeId": "2b4066cd37a341088e32a81e04a56817", + "attendeeName": "Attendee 1", + "videoUserId": null, + "hasJoined": false }, - { - "type": "null" - } - ], - "description": "The topic to which the attendee/guide can send updates" - }, - "JWTMercureSubscriberToken": { - "oneOf": [ - { - "type": "string" + "302108ad602b4ac687f5247aae5d0297": { + "attendeeId": "302108ad602b4ac687f5247aae5d0297", + "attendeeName": null, + "videoUserId": null, + "hasJoined": true }, - { - "type": "null" - } - ], - "description": "The JWT mercure token to publish updates" - }, - "mercureHubPublicUrl": { - "oneOf": [ - { - "type": "string" + "5a3b4e84acab47119b8a6bceb79e732e": { + "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", + "attendeeName": "Test attende name", + "videoUserId": null, + "hasJoined": true }, - { - "type": "null" - } - ], - "description": "The mercure hub url to connect for subscribing and updating" - }, - "JWTMercurePublisherToken": { - "oneOf": [ - { - "type": "string" + "b6358241e4ad4a4e99d0f729d21d63be": { + "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", + "attendeeName": null, + "videoUserId": null, + "hasJoined": true }, - { - "type": "null" + "f1bb9374308d4e088c29d10a2fc8cc07": { + "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", + "attendeeName": null, + "videoUserId": null, + "hasJoined": false } - ], - "description": "The JWT mercure token to subscribe for updates" + }, + "guides": { + "1850bbdc12dc44aba95bc78b16c3643c": { + "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", + "attendeeName": " admin", + "videoUserId": null, + "hasJoined": true + } + }, + "videoGuideToken": null, + "quickViewState": [], + "extensions": [] + } + } + }, + "GetAttendeeInsightsResponse": { + "type": "object", + "description": "Returns aggregations for the current attendees within the appointment.", + "properties": { + "attendees": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/AttendeeInsights" + } }, - "id": { + "currencyId": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The appointment id" + "pattern": "^[0-9a-f]{32}$" }, - "newContextToken": { - "type": "string", - "description": "The new context token will be used in the header (sw-context-token) for calling the other routes" + "currencySymbol": { + "type": "string" + } + }, + "example": { + "extensions": [], + "attendees": { + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } }, - "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" - }, - "attendeeName": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The name of the attendee" - }, - "videoUserId": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The video user id that attendee could use" - }, - "b2bFeatures": { - "type": "object", - "description": "The b2b features that available for the appointment", - "properties": { - "quoteManagement": { - "type": "boolean", - "description": "To know if the quote management is enabled for current customer" - } + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$" + } + }, + "CartItems": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" } } - }, - "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", - "attendeeName": "attendee name", - "videoUserId": null, - "b2bFeatures": { - "feature1": false, - "feature2": true - }, - "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_digital_sales_rooms_content_appointment_struct_appointment_join_struct" } }, - "StateForAll": { + "DiscountType": { + "type": "string", + "description": "Type of the discount", + "enum": [ + "percentage", + "absolute" + ] + }, + "AddTempDiscountRequestBody": { "type": "object", + "required": [ + "discountType", + "discountValue", + "appliedItemIds" + ], "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 - }, - "currentSlideData": { - "anyOf": [ - { - "$ref": "#/components/schemas/DynamicProductListingPageOpenedPayload" - }, - { - "type": "null" - } - ] - }, - "currentDynamicPage": { - "$ref": "#/components/schemas/DynamicPageOpenedPayload" - }, - "started": { - "type": "boolean", - "default": false - }, - "running": { - "type": "boolean", - "default": false + "discountType": { + "$ref": "#/components/schemas/DiscountType" }, - "ended": { - "type": "boolean", - "default": false + "discountValue": { + "type": "number", + "description": "Value of the discount (leave it 0 if you want to remove the discount)", + "maximum": 0 }, - "startedAt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] + "appliedItemIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the items to which the discount should be applied" + } + } + }, + "AddCartDiscountRequestBody": { + "type": "object", + "required": [ + "discountType", + "discountValue" + ], + "properties": { + "discountType": { + "$ref": "#/components/schemas/DiscountType" }, - "endedAt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] + "discountValue": { + "type": "number", + "description": "Value of the discount (leave it 0 if you want to remove the discount)", + "maximum": 0 + } + } + }, + "CartPriceReference": { + "type": "object", + "properties": { + "purchaseUnit": { + "type": "number" }, - "accessibleFrom": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] + "referenceUnit": { + "type": "number" }, - "accessibleTo": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] + "unitName": { + "type": "string" }, - "appointmentMode": { - "type": "string", - "enum": [ - "guided", - "self" - ] + "price": { + "type": "number" }, - "videoAudioSettings": { + "apiAlias": { "type": "string", "enum": [ - "both", - "none", - "audio-only" - ], - "default": "none" - }, - "videoRoomUrl": { - "type": "string", - "default": "" - }, - "attendeeRestrictionType": { - "anyOf": [ - { - "type": "string", - "enum": [ - "open", - "customer", - "rules" - ] - }, - { - "type": "null" - } + "cart_price_reference" ] }, - "productDetailDefaultPageId": { - "anyOf": [ + "listPrice": { + "oneOf": [ { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "$ref": "#/components/schemas/CartListPrice" }, { "type": "null" } ] }, - "quickviewPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" }, - { - "type": "null" - } - ] - }, - "productListingDefaultPageId": { - "anyOf": [ - { + "apiAlias": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "broadcastMode": { - "type": "boolean", - "default": false - }, - "viewMode": { - "type": "string", - "enum": [ - "onlyYou", - "presentation", - "videoGrid" - ], - "default": "presentation" - }, - "allowScreenSharing": { - "type": "boolean", - "default": false - }, - "extensions": { - "type": "array", - "default": [] - } - } - }, - "Cart": { - "type": "object", - "properties": { - "name": { - "description": "Name of the cart - for example `guest-cart`", - "type": "string" - }, - "token": { - "description": "Context token identifying the cart and the user session", - "type": "string" - }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" - }, - "lineItems": { - "description": "All items within the cart", - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - }, - "errors": { - "type": "array", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "items": { - "$ref": "#/components/schemas/CartError" - } - }, - "deliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDelivery" - } - }, - "transactions": { - "description": "A list of all payment transactions associated with the current cart.", - "type": "array", - "items": { - "type": "object", - "properties": { - "paymentMethodId": { - "type": "string" - }, - "amount": { - "$ref": "#/components/schemas/CalculatedPrice" - } + "enum": [ + "cart_regulation_price" + ] } - } - }, - "modified": { - "type": "boolean" - }, - "customerComment": { - "type": "string", - "description": "A comment that can be added to the cart.", + }, "nullable": true }, - "affiliateCode": { - "type": "string", - "description": "An affiliate tracking code", - "nullable": true + "hasRange": { + "type": "boolean" }, - "campaignCode": { + "variantId": { "type": "string", - "description": "A campaign tracking code", + "format": "^[0-9a-f]{32}$", "nullable": true } - } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] }, - "VideoChatCreateStruct": { + "AttendeeInsights": { "type": "object", - "description": "Includes all data you will need to attend to a appointment.", + "description": "Attendee Insights", "properties": { - "roomUrl": { - "type": "string", - "description": "Url of the video room in daily" - }, - "roomName": { + "id": { "type": "string", - "description": "Name of the video room in daily" + "pattern": "^[0-9a-f]{32}$", + "description": "Id of the attendee" }, - "userToken": { - "type": "string", - "description": "Token for the end users to connect to the daily room" + "cartSum": { + "type": "number", + "description": "Sum of the cart net in base currency" }, - "ownerToken": { - "type": "string", - "description": "Token for the room owner (guide) to connect to the daily room" + "productCount": { + "type": "number", + "description": "Sum of all quantities in the cart which were added during the appointment" } }, "example": { - "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", - "userToken": "dummy user token", - "ownerToken": "dummy owner token", - "roomName": "rSq20mrgwsj4eIXo1u95", - "extensions": [] + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } + } + }, + "DynamicProductListingPageOpenedPayload": { + "required": [ + "page" + ], + "properties": { + "page": { + "type": "integer", + "description": "Current page position in the pagination" + } } }, "StateForGuides": { @@ -56417,1394 +53946,1482 @@ } } }, - "DiscountType": { - "type": "string", - "description": "Type of the discount", - "enum": [ - "percentage", - "absolute" - ] - }, - "AddTempDiscountRequestBody": { + "AbstractDynamicPageOpenedPayload": { "type": "object", "required": [ - "discountType", - "discountValue", - "appliedItemIds" + "type" ], "properties": { - "discountType": { - "$ref": "#/components/schemas/DiscountType" - }, - "discountValue": { - "type": "number", - "description": "Value of the discount (leave it 0 if you want to remove the discount)", - "maximum": 0 + "type": { + "type": "string", + "description": "The type of the current dynamic page" }, - "appliedItemIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the items to which the discount should be applied" + "opened": { + "type": "boolean", + "default": true } } }, - "AddCartDiscountRequestBody": { + "LineItemType": { + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "discount", + "container", + "quantity", + "dsr-line-item-discount", + "dsr-cart-discount" + ] + }, + "DiscountLineItemPayload": { "type": "object", - "required": [ - "discountType", - "discountValue" - ], "properties": { "discountType": { - "$ref": "#/components/schemas/DiscountType" + "type": "string", + "enum": [ + "percentage", + "absolute" + ] }, "discountValue": { "type": "number", - "description": "Value of the discount (leave it 0 if you want to remove the discount)", + "format": "float", + "maximum": 0 + }, + "discountPrice": { + "type": "number", + "format": "float", "maximum": 0 } } }, - "GuidePresentationStateResponse": { + "LineItem": { "type": "object", "properties": { - "stateForAll": { - "$ref": "#/components/schemas/StateForAll" + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "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", - "broadcastMode": false, - "extensions": [] + "cover": { + "$ref": "#/components/schemas/ProductMedia" }, - "stateForGuides": { - "clients": [], - "inactiveClients": { - "2b4066cd37a341088e32a81e04a56817": { - "attendeeId": "2b4066cd37a341088e32a81e04a56817", - "attendeeName": "Attendee 1", - "videoUserId": null, - "hasJoined": false - }, - "302108ad602b4ac687f5247aae5d0297": { - "attendeeId": "302108ad602b4ac687f5247aae5d0297", - "attendeeName": null, - "videoUserId": null, - "hasJoined": true - }, - "5a3b4e84acab47119b8a6bceb79e732e": { - "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", - "attendeeName": "Test attende name", - "videoUserId": null, - "hasJoined": true - }, - "b6358241e4ad4a4e99d0f729d21d63be": { - "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", - "attendeeName": null, - "videoUserId": null, - "hasJoined": true - }, - "f1bb9374308d4e088c29d10a2fc8cc07": { - "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", - "attendeeName": null, - "videoUserId": null, - "hasJoined": false - } - }, - "guides": { - "1850bbdc12dc44aba95bc78b16c3643c": { - "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", - "attendeeName": " admin", - "videoUserId": null, - "hasJoined": true - } - }, - "videoGuideToken": null, - "quickViewState": [], - "extensions": [] - } - } - }, - "GetCartInsightsResponse": { - "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" + "dataContextHash": { + "type": "string" }, - "productCount": { - "type": "number", - "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" + "dataTimestamp": { + "type": "string" }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the shown currency" + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" }, - "currencySymbol": { - "type": "string", - "description": "The currency symbol from the shown currency" + "description": { + "type": "string" }, - "topProducts": { + "good": { + "type": "boolean" + }, + "id": { + "type": "string" + }, + "label": { + "type": "string" + }, + "modified": { + "type": "boolean" + }, + "modifiedByApp": { + "type": "boolean" + }, + "payload": { + "allOf": [ + { + "$ref": "#/components/schemas/ProductJsonApi" + }, + { + "type": "object", + "properties": { + "discountType": { + "type": "string", + "enum": [ + "percentage", + "absolute" + ] + }, + "discountValue": { + "type": "number", + "format": "float", + "maximum": 0 + }, + "discountPrice": { + "type": "number", + "format": "float", + "maximum": 0 + } + } + } + ] + }, + "extensions": { "type": "object", - "required": [ - "byQuantity", - "byRevenue" - ], "properties": { - "byQuantity": { + "meta": { + "type": "object", + "properties": { + "attendees": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + } + } + } + } + } + } + } + }, + "price": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] + }, + "calculatedTaxes": { "type": "array", - "uniqueItems": true, "items": { "type": "object", "properties": { - "productId": { + "apiAlias": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the product" + "enum": [ + "cart_tax_calculated" + ] }, - "value": { - "type": "number", - "description": "The quantity in carts of this product" + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" } }, "required": [ - "productId", - "value" + "apiAlias", + "tax", + "taxRate", + "price" ] } }, - "byRevenue": { + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "quantity": { + "type": "number" + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + }, + "nullable": true + }, + "totalPrice": { + "type": "number" + }, + "unitPrice": { + "type": "number" + }, + "taxRules": { "type": "array", - "uniqueItems": true, + "description": "Currently active tax rules and/or rates", "items": { "type": "object", "properties": { - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the product" - }, - "value": { + "taxRate": { "type": "number", - "description": "The net revenue in the shown currency in carts of this product" + "format": "float" + }, + "name": { + "type": "string" } - }, - "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 + }, + "required": [ + "apiAlias", + "totalPrice", + "quantity", + "unitPrice" + ] + }, + "priceDefinition": { + "$ref": "#/components/schemas/CartPriceQuantity" + }, + "quantity": { + "type": "number" + }, + "quantityInformation": { + "type": "object", + "properties": { + "maxPurchase": { + "type": "number" }, - { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1152.62 + "minPurchase": { + "type": "number" }, - { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 284.88 + "purchaseSteps": { + "type": "number" } - ] + } + }, + "referencedId": { + "type": "string" + }, + "removable": { + "type": "boolean" + }, + "stackable": { + "type": "boolean" + }, + "states": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "is-physical", + "is-download" + ] + } + }, + "type": { + "$ref": "#/components/schemas/LineItemType" + }, + "uniqueIdentifier": { + "type": "string" } - } + }, + "required": [ + "id", + "type" + ] }, - "CartListPrice": { + "DynamicPageOpenedPayload": { + "allOf": [ + { + "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" + } + ] + }, + "CartPriceQuantity": { "type": "object", - "description": "", "properties": { - "discount": { - "type": "number" + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_quantity" + ] }, - "percentage": { - "type": "number" + "isCalculated": { + "type": "boolean" + }, + "listPrice": { + "$ref": "#/components/schemas/CartListPrice" }, "price": { "type": "number" }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_list_price" - ] + "quantity": { + "type": "number" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "taxRules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } + }, + "type": { + "type": "string" } }, "required": [ "apiAlias" ] }, - "GetAttendeeInsightsResponse": { + "Cart": { "type": "object", - "description": "Returns aggregations for the current attendees within the appointment.", "properties": { - "attendees": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/AttendeeInsights" - } - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "description": "Name of the cart - for example `guest-cart`", + "type": "string" }, - "currencySymbol": { + "token": { + "description": "Context token identifying the cart and the user session", "type": "string" - } - }, - "example": { - "extensions": [], - "attendees": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } }, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$" - } - }, - "CartItems": { - "type": "object", - "properties": { - "items": { + "price": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "lineItems": { + "description": "All items within the cart", "type": "array", "items": { "$ref": "#/components/schemas/LineItem" } + }, + "errors": { + "type": "array", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "items": { + "$ref": "#/components/schemas/CartError" + } + }, + "deliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDelivery" + } + }, + "transactions": { + "description": "A list of all payment transactions associated with the current cart.", + "type": "array", + "items": { + "type": "object", + "properties": { + "paymentMethodId": { + "type": "string" + }, + "amount": { + "$ref": "#/components/schemas/CalculatedPrice" + } + } + } + }, + "modified": { + "type": "boolean" + }, + "customerComment": { + "type": "string", + "description": "A comment that can be added to the cart.", + "nullable": true + }, + "affiliateCode": { + "type": "string", + "description": "An affiliate tracking code", + "nullable": true + }, + "campaignCode": { + "type": "string", + "description": "A campaign tracking code", + "nullable": true } } }, - "BasePresentationSlideData": { + "CartError": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" - }, - "extensions": { + "items": { "type": "object", "properties": { - "cmsPageRelation": { - "$ref": "#/components/schemas/PresentationCmsPage" + "key": { + "type": "string" + }, + "level": { + "type": "number", + "enum": [ + 0, + 10, + 20 + ], + "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" + }, + "message": { + "type": "string" + }, + "messageKey": { + "type": "string" } } } } }, - "PresentationSlideData": { + "VideoChatCreateStruct": { "type": "object", + "description": "Includes all data you will need to attend to a appointment.", "properties": { - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" - }, - "extensions": { - "type": "object", - "properties": { - "cmsPageRelation": { - "$ref": "#/components/schemas/PresentationCmsPage" - } - } + "roomUrl": { + "type": "string", + "description": "Url of the video room in daily" }, - "product": { - "$ref": "#/components/schemas/Product" + "roomName": { + "type": "string", + "description": "Name of the video room in daily" }, - "category": { - "$ref": "#/components/schemas/Category" + "userToken": { + "type": "string", + "description": "Token for the end users to connect to the daily room" }, - "configurator": { + "ownerToken": { + "type": "string", + "description": "Token for the room owner (guide) to connect to the daily room" + } + }, + "example": { + "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", + "userToken": "dummy user token", + "ownerToken": "dummy owner token", + "roomName": "rSq20mrgwsj4eIXo1u95", + "extensions": [] + } + }, + "JoinAppointmentResponse": { + "type": "object", + "description": "Includes all data you will need to attend to a appointment.", + "properties": { + "mercureSubscriberTopics": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroup" + "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 will be used in the header (sw-context-token) for calling the other routes" + }, + "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" + }, + "attendeeName": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the attendee" + }, + "videoUserId": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The video user id that attendee could use" + }, + "b2bFeatures": { + "type": "object", + "description": "The b2b features that available for the appointment", + "properties": { + "quoteManagement": { + "type": "boolean", + "description": "To know if the quote management is enabled for current customer" + } } } }, "example": { - "extensions": { - "cmsPageRelation": { - "translated": { - "title": null - }, - "createdAt": "2023-08-09T11:00:13.160+00:00", - "updatedAt": null, - "presentationId": "506cce706e914c1e8b083f05670d85c4", - "cmsPageId": "33e88c7994fa4cf79a1265e5105b93b2", - "title": null, - "productId": null, - "productStreamId": null, - "position": 2, - "isInstantListing": false, - "cmsPage": { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": { - "name": "Default Digital Sales Rooms product listing page", - "customFields": [] - }, - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "name": "Default Digital Sales Rooms product listing page", - "type": "presentation_product_list", - "entity": null, - "sections": [ + "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", + "attendeeName": "attendee name", + "videoUserId": null, + "b2bFeatures": { + "feature1": false, + "feature2": true + }, + "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_digital_sales_rooms_content_appointment_struct_appointment_join_struct" + } + }, + "PresentationCmsPage": { + "allOf": [ + { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + }, + { + "type": "object", + "properties": { + "pickedProductIds": { + "anyOf": [ { - "translated": [], - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "default", - "blocks": [ - { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": [], - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "product-listing", - "slots": [ - { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": { - "config": { - "filters": { - "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", - "source": "static" - }, - "boxLayout": { - "value": "standard", - "source": "static" - }, - "showSorting": { - "value": true, - "source": "static" - }, - "defaultSorting": { - "value": "", - "source": "static" - }, - "useCustomSorting": { - "value": false, - "source": "static" - }, - "availableSortings": { - "value": [], - "source": "static" - }, - "propertyWhitelist": { - "value": [], - "source": "static" - } - }, - "customFields": [] - }, - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "product-listing", - "slot": "content", - "block": null, - "blockId": "96ea8b9676a5461c9149d205d792ecf2", - "config": { - "filters": { - "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", - "source": "static" - }, - "boxLayout": { - "value": "standard", - "source": "static" - }, - "showSorting": { - "value": true, - "source": "static" - }, - "defaultSorting": { - "value": "", - "source": "static" - }, - "useCustomSorting": { - "value": false, - "source": "static" - }, - "availableSortings": { - "value": [], - "source": "static" - }, - "propertyWhitelist": { - "value": [], - "source": "static" - } - }, - "fieldConfig": null, - "translations": null, - "data": null, - "locked": false, - "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "customFields": null, - "apiAlias": "cms_slot" - } - ], - "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", - "position": 0, - "name": null, - "sectionPosition": "main", - "marginTop": "20px", - "marginBottom": "20px", - "marginLeft": "20px", - "marginRight": "20px", - "backgroundColor": null, - "backgroundMediaId": null, - "backgroundMedia": null, - "backgroundMediaMode": "cover", - "cssClass": null, - "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "visibility": null, - "customFields": null, - "apiAlias": "cms_block" - } - ], - "pageId": "33e88c7994fa4cf79a1265e5105b93b2", - "page": null, - "position": 0, - "sizingMode": "boxed", - "mobileBehavior": "wrap", - "backgroundColor": null, - "backgroundMediaId": null, - "backgroundMedia": null, - "backgroundMediaMode": "cover", - "cssClass": null, - "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "visibility": null, - "customFields": null, - "apiAlias": "cms_section" + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Product id" + } + }, + { + "type": "null" } ], - "translations": null, - "cssClass": null, - "config": null, - "previewMediaId": null, - "previewMedia": null, - "landingPages": null, - "id": "33e88c7994fa4cf79a1265e5105b93b2", - "customFields": null, - "apiAlias": "cms_page" - }, - "pickedProductIds": null, - "dsrPresentationVersionId": "213769ba28dd4ee788bdb49dc9ce53d2", - "id": "4ee08e142ed046eb99681594f67599f1", - "customFields": null, - "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "apiAlias": "dsr_presentation_cms_page" + "description": "The product id is assigned to presentation if it's product listing or instant listing" + } } + } + ] + }, + "StateForAll": { + "type": "object", + "properties": { + "currentGuideProductId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] }, - "cmsPage": { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": { - "name": "Default Digital Sales Rooms product listing page", - "customFields": [] - }, - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "name": "Default Digital Sales Rooms product listing page", - "type": "presentation_product_list", - "entity": null, - "sections": [ + "lastActiveGuideSection": { + "anyOf": [ { - "translated": [], - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "default", - "blocks": [ - { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": [], - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "product-listing", - "slots": [ - { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": { - "config": { - "filters": { - "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", - "source": "static" - }, - "boxLayout": { - "value": "standard", - "source": "static" - }, - "showSorting": { - "value": true, - "source": "static" - }, - "defaultSorting": { - "value": "", - "source": "static" - }, - "useCustomSorting": { - "value": false, - "source": "static" - }, - "availableSortings": { - "value": [], - "source": "static" - }, - "propertyWhitelist": { - "value": [], - "source": "static" - } - }, - "customFields": [] - }, - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "product-listing", - "slot": "content", - "block": null, - "blockId": "96ea8b9676a5461c9149d205d792ecf2", - "config": { - "filters": { - "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", - "source": "static" - }, - "boxLayout": { - "value": "standard", - "source": "static" - }, - "showSorting": { - "value": true, - "source": "static" - }, - "defaultSorting": { - "value": "", - "source": "static" - }, - "useCustomSorting": { - "value": false, - "source": "static" - }, - "availableSortings": { - "value": [], - "source": "static" - }, - "propertyWhitelist": { - "value": [], - "source": "static" - } - }, - "fieldConfig": null, - "translations": null, - "data": { - "listing": { - "elements": [ - { - "versionId": null, - "translated": [], - "createdAt": null, - "updatedAt": null, - "parentId": null, - "childCount": null, - "taxId": null, - "manufacturerId": null, - "unitId": null, - "active": null, - "displayGroup": null, - "manufacturerNumber": null, - "ean": null, - "sales": null, - "productNumber": null, - "stock": null, - "availableStock": null, - "available": null, - "deliveryTimeId": null, - "deliveryTime": null, - "restockTime": null, - "isCloseout": null, - "purchaseSteps": null, - "maxPurchase": null, - "minPurchase": null, - "purchaseUnit": null, - "referenceUnit": null, - "shippingFree": null, - "markAsTopseller": null, - "weight": null, - "width": null, - "height": null, - "length": null, - "releaseDate": null, - "categoryTree": null, - "streamIds": null, - "optionIds": null, - "propertyIds": null, - "name": null, - "keywords": null, - "description": null, - "metaDescription": null, - "metaTitle": null, - "packUnit": null, - "packUnitPlural": null, - "tax": null, - "manufacturer": null, - "unit": null, - "cover": null, - "parent": null, - "children": null, - "media": null, - "cmsPageId": null, - "cmsPage": null, - "translations": null, - "categories": null, - "properties": null, - "options": null, - "configuratorSettings": null, - "categoriesRo": null, - "coverId": null, - "categoryIds": null, - "productReviews": null, - "ratingAverage": null, - "mainCategories": null, - "seoUrls": null, - "crossSellings": null, - "canonicalProductId": null, - "canonicalProduct": null, - "streams": null, - "downloads": null, - "states": [], - "id": "a32702bb0b1443e3881c3b9a38c09169", - "customFields": null, - "apiAlias": "product" - } - ], - "aggregations": [], - "page": 1, - "limit": null, - "entity": "product", - "total": 0, - "states": [], - "apiAlias": "dal_entity_search_result" - }, - "apiAlias": "cms_product_listing" - }, - "locked": false, - "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "customFields": null, - "apiAlias": "cms_slot" - } - ], - "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", - "position": 0, - "name": null, - "sectionPosition": "main", - "marginTop": "20px", - "marginBottom": "20px", - "marginLeft": "20px", - "marginRight": "20px", - "backgroundColor": null, - "backgroundMediaId": null, - "backgroundMedia": null, - "backgroundMediaMode": "cover", - "cssClass": null, - "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "visibility": null, - "customFields": null, - "apiAlias": "cms_block" - } - ], - "pageId": "33e88c7994fa4cf79a1265e5105b93b2", - "page": null, - "position": 0, - "sizingMode": "boxed", - "mobileBehavior": "wrap", - "backgroundColor": null, - "backgroundMediaId": null, - "backgroundMedia": null, - "backgroundMediaMode": "cover", - "cssClass": null, - "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "visibility": null, - "customFields": null, - "apiAlias": "cms_section" + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" } - ], - "translations": null, - "cssClass": null, - "config": null, - "previewMediaId": null, - "previewMedia": null, - "landingPages": null, - "id": "33e88c7994fa4cf79a1265e5105b93b2", - "customFields": null, - "apiAlias": "cms_page" - }, - "category": { - "versionId": null, - "translated": { - "breadcrumb": [] - }, - "createdAt": null, - "updatedAt": null, - "afterCategoryId": null, - "parentId": null, - "mediaId": null, - "name": null, - "breadcrumb": [], - "path": null, - "level": null, - "active": null, - "childCount": null, - "visibleChildCount": 0, - "displayNestedProducts": null, - "parent": null, - "children": null, - "translations": null, - "media": null, - "cmsPageId": null, - "cmsPageIdSwitched": false, - "cmsPage": null, - "linkType": null, - "linkNewTab": null, - "internalLink": null, - "externalLink": null, - "visible": null, - "type": null, - "productAssignmentType": null, - "description": null, - "metaTitle": null, - "metaDescription": null, - "keywords": null, - "seoUrls": null, - "customEntityTypeId": null, - "id": "34f21c5eb6d54a939f10973204aa5f08", - "customFields": null, - "apiAlias": "category" + ] }, - "apiAlias": "pwa_page_result" - } - }, - "DynamicPageOpenedPayload": { - "allOf": [ - { - "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" - } - ] - }, - "CartDeliveryPosition": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "deliveryDate": { - "type": "object", - "properties": { - "earliest": { + "currentPageId": { + "anyOf": [ + { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "latest": { + { + "type": "null" + } + ] + }, + "currentSectionId": { + "anyOf": [ + { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" } - } + ] }, - "identifier": { - "type": "string" + "currentSlideAlias": { + "type": "integer", + "default": 0 }, - "lineItem": { - "$ref": "#/components/schemas/LineItem" + "currentSlideData": { + "anyOf": [ + { + "$ref": "#/components/schemas/DynamicProductListingPageOpenedPayload" + }, + { + "type": "null" + } + ] }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" - } - } - }, - "CartPriceReference": { - "type": "object", - "properties": { - "purchaseUnit": { - "type": "number" + "currentDynamicPage": { + "$ref": "#/components/schemas/DynamicPageOpenedPayload" }, - "referenceUnit": { - "type": "number" + "started": { + "type": "boolean", + "default": false }, - "unitName": { - "type": "string" + "running": { + "type": "boolean", + "default": false }, - "price": { - "type": "number" + "ended": { + "type": "boolean", + "default": false }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_reference" + "startedAt": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } ] }, - "listPrice": { - "oneOf": [ + "endedAt": { + "anyOf": [ { - "$ref": "#/components/schemas/CartListPrice" + "type": "string", + "format": "date-time" }, { "type": "null" } ] }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { + "accessibleFrom": { + "anyOf": [ + { "type": "string", - "enum": [ - "cart_regulation_price" - ] + "format": "date-time" + }, + { + "type": "null" } - }, - "nullable": true + ] }, - "hasRange": { - "type": "boolean" + "accessibleTo": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] }, - "variantId": { + "appointmentMode": { "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true - } - }, - "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitName" - ] - }, - "CalculatedPrice": { - "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", - "properties": { - "unitPrice": { - "type": "number" - }, - "quantity": { - "type": "number" + "enum": [ + "guided", + "self" + ] }, - "rawTotal": { - "type": "number" + "videoAudioSettings": { + "type": "string", + "enum": [ + "both", + "none", + "audio-only" + ], + "default": "none" }, - "totalPrice": { - "type": "number" + "videoRoomUrl": { + "type": "string", + "default": "" }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" - } + "attendeeRestrictionType": { + "anyOf": [ + { + "type": "string", + "enum": [ + "open", + "customer", + "rules" + ] }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] - } + { + "type": "null" + } + ] }, - "referencePrice": { - "oneOf": [ + "productDetailDefaultPageId": { + "anyOf": [ { - "$ref": "#/components/schemas/CartPriceReference" + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, { "type": "null" } ] }, - "listPrice": { - "oneOf": [ + "quickviewPageId": { + "anyOf": [ { - "$ref": "#/components/schemas/CartListPrice" + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, { "type": "null" } ] }, - "positionPrice": { - "type": "number" - }, - "netPrice": { - "type": "number" - }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { + "productListingDefaultPageId": { + "anyOf": [ + { "type": "string", - "enum": [ - "cart_regulation_price" - ] + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" } - }, - "nullable": true - }, - "hasRange": { - "type": "boolean" + ] }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true + "broadcastMode": { + "type": "boolean", + "default": false }, - "apiAlias": { + "viewMode": { "type": "string", "enum": [ - "calculated_price" - ] + "onlyYou", + "presentation", + "videoGrid" + ], + "default": "presentation" }, - "taxRules": { + "allowScreenSharing": { + "type": "boolean", + "default": false + }, + "extensions": { "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } + "default": [] } - }, - "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "referencePrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitPrice", - "positionPrice", - "netPrice", - "taxRules" - ] + } }, - "AttendeeInsights": { + "CartDeliveryPosition": { "type": "object", - "description": "Attendee Insights", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Id of the attendee" + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } }, - "cartSum": { - "type": "number", - "description": "Sum of the cart net in base currency" + "identifier": { + "type": "string" }, - "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 + "lineItem": { + "$ref": "#/components/schemas/LineItem" + }, + "price": { + "$ref": "#/components/schemas/CalculatedPrice" } } }, - "LineItemType": { - "type": "string", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "discount", - "container", - "quantity", - "dsr-line-item-discount", - "dsr-cart-discount" - ] - }, - "DiscountLineItemPayload": { + "GetListBodyRequest": { "type": "object", "properties": { - "discountType": { - "type": "string", - "enum": [ - "percentage", - "absolute" - ] - }, - "discountValue": { - "type": "number", - "format": "float", - "maximum": 0 + "limit": { + "type": "integer", + "description": "Max amount of resources to be returned in a page" }, - "discountPrice": { - "type": "number", - "format": "float", - "maximum": 0 + "page": { + "type": "integer", + "description": "The page to be returned" } } }, - "LineItem": { + "CartDelivery": { "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - }, - "cover": { - "$ref": "#/components/schemas/ProductMedia" - }, - "dataContextHash": { - "type": "string" - }, - "dataTimestamp": { - "type": "string" - }, - "deliveryInformation": { - "$ref": "#/components/schemas/CartDeliveryInformation" - }, - "description": { - "type": "string" - }, - "good": { - "type": "boolean" - }, - "id": { - "type": "string" - }, - "label": { - "type": "string" - }, - "modified": { - "type": "boolean" - }, - "modifiedByApp": { - "type": "boolean" - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/ProductJsonApi" - }, - { - "type": "object", - "properties": { - "discountType": { - "type": "string", - "enum": [ - "percentage", - "absolute" - ] - }, - "discountValue": { - "type": "number", - "format": "float", - "maximum": 0 - }, - "discountPrice": { - "type": "number", - "format": "float", - "maximum": 0 - } - } - } - ] - }, - "extensions": { + "deliveryDate": { "type": "object", "properties": { - "meta": { - "type": "object", - "properties": { - "attendees": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - } - } - } - } - } + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" } } }, - "price": { + "location": { "type": "object", "properties": { "apiAlias": { "type": "string", "enum": [ - "calculated_price" - ] - }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" - } - }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] - } - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] - }, - "quantity": { - "type": "number" - }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } + "cart_delivery_shipping_location" ] }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true - }, - "totalPrice": { - "type": "number" + "country": { + "$ref": "#/components/schemas/Country" }, - "unitPrice": { - "type": "number" + "address": { + "$ref": "#/components/schemas/CustomerAddress" }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } + "state": { + "$ref": "#/components/schemas/CountryState" } - }, - "required": [ - "apiAlias", - "totalPrice", - "quantity", - "unitPrice" - ] + } }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDeliveryPosition" + } }, - "quantity": { - "type": "number" + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" }, - "quantityInformation": { + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + }, + "BasePresentationSlideData": { + "properties": { + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" + }, + "extensions": { "type": "object", "properties": { - "maxPurchase": { - "type": "number" - }, - "minPurchase": { - "type": "number" - }, - "purchaseSteps": { - "type": "number" + "cmsPageRelation": { + "$ref": "#/components/schemas/PresentationCmsPage" } } + } + } + }, + "PresentationSlideData": { + "type": "object", + "properties": { + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" }, - "referencedId": { - "type": "string" + "extensions": { + "type": "object", + "properties": { + "cmsPageRelation": { + "$ref": "#/components/schemas/PresentationCmsPage" + } + } }, - "removable": { - "type": "boolean" + "product": { + "$ref": "#/components/schemas/Product" }, - "stackable": { - "type": "boolean" + "category": { + "$ref": "#/components/schemas/Category" }, - "states": { + "configurator": { "type": "array", "items": { - "type": "string", - "enum": [ - "is-physical", - "is-download" - ] + "$ref": "#/components/schemas/PropertyGroup" } - }, - "type": { - "$ref": "#/components/schemas/LineItemType" - }, - "uniqueIdentifier": { - "type": "string" } }, - "required": [ - "id", - "type" - ] - }, - "AbstractDynamicPageOpenedPayload": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "description": "The type of the current dynamic page" + "example": { + "extensions": { + "cmsPageRelation": { + "translated": { + "title": null + }, + "createdAt": "2023-08-09T11:00:13.160+00:00", + "updatedAt": null, + "presentationId": "506cce706e914c1e8b083f05670d85c4", + "cmsPageId": "33e88c7994fa4cf79a1265e5105b93b2", + "title": null, + "productId": null, + "productStreamId": null, + "position": 2, + "isInstantListing": false, + "cmsPage": { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "name": "Default Digital Sales Rooms product listing page", + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "name": "Default Digital Sales Rooms product listing page", + "type": "presentation_product_list", + "entity": null, + "sections": [ + { + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "default", + "blocks": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slots": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slot": "content", + "block": null, + "blockId": "96ea8b9676a5461c9149d205d792ecf2", + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "fieldConfig": null, + "translations": null, + "data": null, + "locked": false, + "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "customFields": null, + "apiAlias": "cms_slot" + } + ], + "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", + "position": 0, + "name": null, + "sectionPosition": "main", + "marginTop": "20px", + "marginBottom": "20px", + "marginLeft": "20px", + "marginRight": "20px", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_block" + } + ], + "pageId": "33e88c7994fa4cf79a1265e5105b93b2", + "page": null, + "position": 0, + "sizingMode": "boxed", + "mobileBehavior": "wrap", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_section" + } + ], + "translations": null, + "cssClass": null, + "config": null, + "previewMediaId": null, + "previewMedia": null, + "landingPages": null, + "id": "33e88c7994fa4cf79a1265e5105b93b2", + "customFields": null, + "apiAlias": "cms_page" + }, + "pickedProductIds": null, + "dsrPresentationVersionId": "213769ba28dd4ee788bdb49dc9ce53d2", + "id": "4ee08e142ed046eb99681594f67599f1", + "customFields": null, + "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "apiAlias": "dsr_presentation_cms_page" + } }, - "opened": { - "type": "boolean", - "default": true - } + "cmsPage": { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "name": "Default Digital Sales Rooms product listing page", + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "name": "Default Digital Sales Rooms product listing page", + "type": "presentation_product_list", + "entity": null, + "sections": [ + { + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "default", + "blocks": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slots": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slot": "content", + "block": null, + "blockId": "96ea8b9676a5461c9149d205d792ecf2", + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "fieldConfig": null, + "translations": null, + "data": { + "listing": { + "elements": [ + { + "versionId": null, + "translated": [], + "createdAt": null, + "updatedAt": null, + "parentId": null, + "childCount": null, + "taxId": null, + "manufacturerId": null, + "unitId": null, + "active": null, + "displayGroup": null, + "manufacturerNumber": null, + "ean": null, + "sales": null, + "productNumber": null, + "stock": null, + "availableStock": null, + "available": null, + "deliveryTimeId": null, + "deliveryTime": null, + "restockTime": null, + "isCloseout": null, + "purchaseSteps": null, + "maxPurchase": null, + "minPurchase": null, + "purchaseUnit": null, + "referenceUnit": null, + "shippingFree": null, + "markAsTopseller": null, + "weight": null, + "width": null, + "height": null, + "length": null, + "releaseDate": null, + "categoryTree": null, + "streamIds": null, + "optionIds": null, + "propertyIds": null, + "name": null, + "keywords": null, + "description": null, + "metaDescription": null, + "metaTitle": null, + "packUnit": null, + "packUnitPlural": null, + "tax": null, + "manufacturer": null, + "unit": null, + "cover": null, + "parent": null, + "children": null, + "media": null, + "cmsPageId": null, + "cmsPage": null, + "translations": null, + "categories": null, + "properties": null, + "options": null, + "configuratorSettings": null, + "categoriesRo": null, + "coverId": null, + "categoryIds": null, + "productReviews": null, + "ratingAverage": null, + "mainCategories": null, + "seoUrls": null, + "crossSellings": null, + "canonicalProductId": null, + "canonicalProduct": null, + "streams": null, + "downloads": null, + "states": [], + "id": "a32702bb0b1443e3881c3b9a38c09169", + "customFields": null, + "apiAlias": "product" + } + ], + "aggregations": [], + "page": 1, + "limit": null, + "entity": "product", + "total": 0, + "states": [], + "apiAlias": "dal_entity_search_result" + }, + "apiAlias": "cms_product_listing" + }, + "locked": false, + "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "customFields": null, + "apiAlias": "cms_slot" + } + ], + "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", + "position": 0, + "name": null, + "sectionPosition": "main", + "marginTop": "20px", + "marginBottom": "20px", + "marginLeft": "20px", + "marginRight": "20px", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_block" + } + ], + "pageId": "33e88c7994fa4cf79a1265e5105b93b2", + "page": null, + "position": 0, + "sizingMode": "boxed", + "mobileBehavior": "wrap", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_section" + } + ], + "translations": null, + "cssClass": null, + "config": null, + "previewMediaId": null, + "previewMedia": null, + "landingPages": null, + "id": "33e88c7994fa4cf79a1265e5105b93b2", + "customFields": null, + "apiAlias": "cms_page" + }, + "category": { + "versionId": null, + "translated": { + "breadcrumb": [] + }, + "createdAt": null, + "updatedAt": null, + "afterCategoryId": null, + "parentId": null, + "mediaId": null, + "name": null, + "breadcrumb": [], + "path": null, + "level": null, + "active": null, + "childCount": null, + "visibleChildCount": 0, + "displayNestedProducts": null, + "parent": null, + "children": null, + "translations": null, + "media": null, + "cmsPageId": null, + "cmsPageIdSwitched": false, + "cmsPage": null, + "linkType": null, + "linkNewTab": null, + "internalLink": null, + "externalLink": null, + "visible": null, + "type": null, + "productAssignmentType": null, + "description": null, + "metaTitle": null, + "metaDescription": null, + "keywords": null, + "seoUrls": null, + "customEntityTypeId": null, + "id": "34f21c5eb6d54a939f10973204aa5f08", + "customFields": null, + "apiAlias": "category" + }, + "apiAlias": "pwa_page_result" } } }, diff --git a/SwagDigitalSalesRooms-adminapi.summary.json b/SwagDigitalSalesRooms-adminapi.summary.json index b01eb3f..d506deb 100644 --- a/SwagDigitalSalesRooms-adminapi.summary.json +++ b/SwagDigitalSalesRooms-adminapi.summary.json @@ -20,15 +20,6 @@ "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics", - "/_action/integration/{integrationId}/mcp-allowlist", - "/_action/mcp/capabilities", - "/_action/mcp/tools", - "/_action/number-range/{numberRangeId}/preview-pattern", - "/_action/user/{userId}/mcp-allowlist", - "/_mcp", - "/aggregate/app-mcp-prompt", - "/aggregate/app-mcp-resource", - "/aggregate/app-mcp-tool", "/aggregate/dsr-appointment", "/aggregate/dsr-appointment-attendee", "/aggregate/dsr-appointment-request", @@ -38,12 +29,6 @@ "/aggregate/dsr-interaction", "/aggregate/dsr-presentation", "/aggregate/dsr-presentation-cms-page", - "/app-mcp-prompt", - "/app-mcp-prompt/{id}", - "/app-mcp-resource", - "/app-mcp-resource/{id}", - "/app-mcp-tool", - "/app-mcp-tool/{id}", "/dsr-appointment", "/dsr-appointment-attendee", "/dsr-appointment-attendee/{id}", @@ -62,9 +47,6 @@ "/dsr-presentation-cms-page", "/dsr-presentation-cms-page/{id}", "/dsr-presentation/{id}", - "/search/app-mcp-prompt", - "/search/app-mcp-resource", - "/search/app-mcp-tool", "/search/dsr-appointment", "/search/dsr-appointment-attendee", "/search/dsr-appointment-request",