From bf996f1c2424cfc9d2dc1cc4e7cc3da2302bc7fe Mon Sep 17 00:00:00 2001 From: shopwareBot Date: Tue, 28 Apr 2026 10:42:40 +0000 Subject: [PATCH] [create-pull-request] automated change --- SwagDigitalSalesRooms-adminapi.json | 5742 ++++++++----------- SwagDigitalSalesRooms-adminapi.summary.json | 10 +- 2 files changed, 2342 insertions(+), 3410 deletions(-) diff --git a/SwagDigitalSalesRooms-adminapi.json b/SwagDigitalSalesRooms-adminapi.json index 277d16b..9a43a5b 100644 --- a/SwagDigitalSalesRooms-adminapi.json +++ b/SwagDigitalSalesRooms-adminapi.json @@ -4884,216 +4884,233 @@ } } }, - "/sales-channel-tracking-customer": { - "get": { + "/_action/dsr/appointment/{appointmentId}/join-as-guide": { + "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Appointment" ], - "summary": "List with basic information of Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingCustomerList", + "summary": "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": "" + } + } + } + }, + "/_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": "List of Sales Channel Tracking Customer resources.", + "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/SalesChannelTrackingCustomer" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/sales-channel-tracking-customer?limit=25" - }, - "last": { - "example": "/sales-channel-tracking-customer?limit=25&page=11" - }, - "next": { - "example": "/sales-channel-tracking-customer?limit=25&page=4" - }, - "prev": { - "example": "/sales-channel-tracking-customer?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" - } + "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": [ - "Sales Channel Tracking Customer", - "Experimental" + "Appointment" ], - "summary": "Create a new Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "createSalesChannelTrackingCustomer", + "summary": "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/SalesChannelTrackingCustomer" + "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 SalesChannelTrackingCustomer", + "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/SalesChannelTrackingCustomer" - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "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/sales-channel-tracking-customer": { - "post": { + }, + "patch": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Appointment" ], - "summary": "Search for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "searchSalesChannelTrackingCustomer", + "summary": "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}$" } } ], @@ -5102,76 +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 SalesChannelTrackingCustomer", + "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/SalesChannelTrackingCustomer" - } - } - } - } - ] - } - }, "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/SalesChannelTrackingCustomer" - } + "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" } } } }, - "/sales-channel-tracking-customer/{id}": { + "/_action/dsr/appointment/{appointmentId}/presentation/state": { "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Appointment" ], - "summary": "Detailed information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingCustomer", + "summary": "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 sales_channel_tracking_customer", + "description": "Appointment id", "required": true, "schema": { "type": "string", @@ -5181,545 +5226,413 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" - } - } + "$ref": "#/components/schemas/GuidePresentationStateResponse" } } } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } - }, - "delete": { + } + }, + "/_action/dsr/appointment/{appointmentId}/video-room": { + "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Appointment" ], - "summary": "Delete a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "deleteSalesChannelTrackingCustomer", + "summary": "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 sales_channel_tracking_customer", + "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": [ - "Sales Channel Tracking Customer", - "Experimental" + "Appointment" ], - "summary": "Partially update information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "updateSalesChannelTrackingCustomer", + "summary": "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 sales_channel_tracking_customer", + "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 Sales Channel Tracking Customer resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" - } + "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 SalesChannelTrackingCustomer", + "description": "", "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" - } - } - } - ] + "$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": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" - } - } + "$ref": "#/components/schemas/GetCartInsightsResponse" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/aggregate/sales-channel-tracking-customer": { - "post": { + "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics": { + "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Appointment" ], - "summary": "Aggregate for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "aggregateSalesChannelTrackingCustomer", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "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}$" + } + }, + { + "name": "order", + "in": "query", + "description": "The order of the cart line items", + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "in": "query", + "description": "The sort of the cart line items", + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { - "description": "List of SalesChannelTrackingCustomer", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" - } - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" - } - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/sales-channel-tracking-order": { + "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics": { "get": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Appointment" ], - "summary": "List with basic information of Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingOrderList", + "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}$" + } + }, { "name": "limit", "in": "query", - "description": "Max amount of resources to be returned in a page", + "description": "The limit of the products which should be returned", "schema": { - "type": "integer" + "type": "integer", + "default": 10 } }, { "name": "page", "in": "query", - "description": "The page to be returned", + "description": "The page of the products which should be returned", "schema": { - "type": "integer" + "type": "integer", + "default": 1 } }, { - "name": "query", + "name": "term", "in": "query", - "description": "Encoded SwagQL in JSON", + "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", + "pattern": "^[0-9a-f]{32}$" + } } ], "responses": { "200": { - "description": "List of Sales Channel Tracking Order 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/SalesChannelTrackingOrder" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/sales-channel-tracking-order?limit=25" - }, - "last": { - "example": "/sales-channel-tracking-order?limit=25&page=11" - }, - "next": { - "example": "/sales-channel-tracking-order?limit=25&page=4" - }, - "prev": { - "example": "/sales-channel-tracking-order?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } - } - } + "$ref": "#/components/schemas/WidgetProductListing" } } } - }, - "401": { - "$ref": "#/components/responses/401" } } - }, - "post": { + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics": { + "get": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Appointment" ], - "summary": "Create a new Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "createSalesChannelTrackingOrder", + "summary": "Get wishlist insights", + "description": "Get wishlist of all the attendees for the given appointment", + "operationId": "getWishlistInsights", "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 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", - "enum": [ - "basic", - "detail" - ] + "pattern": "^[0-9a-f]{32}$" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } - } - } - }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } - } + "$ref": "#/components/schemas/WidgetProductListing" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/search/sales-channel-tracking-order": { + "/_action/dsr/appointment/attendee/{attendeeId}/remove": { "post": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Appointment" ], - "summary": "Search for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "searchSalesChannelTrackingOrder", + "summary": "Remove an attendee from the appointment", + "description": "Remove an attendee from the appointment", + "operationId": "removeAttendee", "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}$" } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, "responses": { "200": { - "description": "List of SalesChannelTrackingOrder", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", "properties": { - "total": { - "type": "integer" + "message": { + "type": "string" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the removed attendee" } + }, + "example": { + "message": "Attendee removed successfully", + "attendeeId": "018c19b80403709cb2cef54f70860042" } } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/sales-channel-tracking-order/{id}": { + "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids": { "get": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Appointment" ], - "summary": "Detailed information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingOrder", + "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 sales_channel_tracking_order", + "description": "Attendee id", "required": true, "schema": { "type": "string", @@ -5729,61 +5642,53 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "", "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { + "type": "object", + "properties": { + "collection": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "lastSeen": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } } } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + }, + "example": { + "collection": { + "lastSeen": [ + "018c19b80403709cb2cef54f70860042", + "018c19b804027291955d8f076c272d0d" + ] } } } } } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } - }, - "delete": { + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/load-temp-cart": { + "get": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Appointment" ], - "summary": "Delete a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "deleteSalesChannelTrackingOrder", + "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 sales_channel_tracking_order", + "description": "Attendee id", "required": true, "schema": { "type": "string", @@ -5791,208 +5696,85 @@ } }, { - "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" } } ], "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/Cart" + } + } + } } } - }, - "patch": { + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/add-temp-discount": { + "post": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Appointment" ], - "summary": "Partially update information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "updateSalesChannelTrackingOrder", + "summary": "Add discount to the temp cart", + "description": "Add discount to the temp cart", + "operationId": "addTempDiscount", "parameters": [ { - "name": "id", + "name": "attendeeId", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "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" - } - } - ], - "requestBody": { - "description": "Partially update information about a Sales Channel Tracking Order resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SalesChannelTrackingOrder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } - } - } - }, - "/aggregate/sales-channel-tracking-order": { - "post": { - "tags": [ - "Sales Channel Tracking Order", - "Experimental" ], - "summary": "Aggregate for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "aggregateSalesChannelTrackingOrder", "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 SalesChannelTrackingOrder", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/{appointmentId}/join-as-guide": { + "/_action/dsr/appointment/attendee/{attendeeId}/remove-temp-discount": { "post": { "tags": [ "Appointment" ], - "summary": "Join a meeting as a guide", - "description": "This route is used to join appointment as guide.", - "operationId": "joinAppointmentAsGuide", + "summary": "Remove all discount from the temp cart", + "description": "Remove all discount from the temp cart", + "operationId": "removeTempDiscount", "parameters": [ { - "name": "appointmentId", + "name": "attendeeId", "in": "path", - "description": "Appointment id", + "description": "Attendee id", "required": true, "schema": { "type": "string", @@ -6006,7 +5788,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JoinAppointmentResponse" + "$ref": "#/components/schemas/Cart" } } } @@ -6014,68 +5796,14 @@ } } }, - "/_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": { + "/_action/dsr/appointment/attendee/{attendeeId}/apply-temp-discount": { "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", + "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", @@ -6090,19 +5818,11 @@ ], "responses": { "200": { - "description": "The sw-context-token from the attendee", + "description": "", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "attendee-sw-context-token": { - "type": "string" - } - }, - "example": { - "attendee-sw-context-token": "context token of attendee" - } + "$ref": "#/components/schemas/Cart" } } } @@ -6110,99 +5830,19 @@ } } }, - "/_action/dsr/appointment/{appointmentId}/instant-listing": { + "/_action/dsr/appointment/attendee/{attendeeId}/add-cart-discount": { "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" - ], - "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": { - "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" - } - }, - "example": { - "index": 1 - } - } - } - } - } - } - }, - "patch": { - "tags": [ - "Appointment" - ], - "summary": "Update a instant listing from the presentation", - "description": "Updates the products for the given listing", - "operationId": "updateInstantListing", + "summary": "Add discount to the attendee cart", + "description": "Add discount to the attendee cart", + "operationId": "addCartDiscount", "parameters": [ { - "name": "appointmentId", + "name": "attendeeId", "in": "path", - "description": "Appointment id", + "description": "Attendee id", "required": true, "schema": { "type": "string", @@ -6215,84 +5855,18 @@ "content": { "application/json": { "schema": { - "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" + "$ref": "#/components/schemas/AddCartDiscountRequestBody" } } } }, "responses": { "200": { - "description": "Updated the instant listing", + "description": "", "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}$" - }, - "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" - } + "$ref": "#/components/schemas/Cart" } } } @@ -6300,53 +5874,29 @@ } } }, - "/_action/dsr/appointment/{appointmentId}/presentation/state": { - "get": { + "/_action/dsr/appointment/{appointmentId}/shopping-lists/{shoppingListId}": { + "post": { "tags": [ "Appointment" ], - "summary": "Get the current presentation state", - "description": "Returns the presentation state for all and the guide", - "operationId": "getGuidePresentationState", + "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": "appointmentId", "in": "path", - "description": "Appointment id", + "description": "The appointment id you are joining", "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", + "name": "shoppingListId", "in": "path", - "description": "Appointment id", + "description": "The shopping list id you want to load", "required": true, "schema": { "type": "string", @@ -6360,689 +5910,43 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/VideoChatCreateStruct" + "type": "object", + "properties": { + "data": { + "type": "object", + "example": { + "data": { + "01938f89c632709ba4d65eb53604bf5b": { + "quantity": "1" + }, + "01938f89c8647036a617b7d88e1e24f5": { + "quantity": "1" + }, + "01938f8a23d47305b1e289163cea5074": { + "quantity": "1" + } + } + } + } + } } } } } - } - }, - "delete": { - "tags": [ - "Appointment" - ], - "summary": "Delete a video room", - "description": "Delete a video room and tokens on the remote video tool", - "operationId": "deleteVideoRoom", - "parameters": [ + }, + "security": [ { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": [] - } + "ApiKey": [] } - } + ] } - }, - "/_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" - } - } - } - } - } - } - }, - "/_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}$" - } - }, - { - "name": "order", - "in": "query", - "description": "The order of the cart line items", - "schema": { - "type": "string" - } - }, - { - "name": "sort", - "in": "query", - "description": "The sort of the cart line items", - "schema": { - "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}$" - } - }, - { - "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 products", - "schema": { - "type": "string" - } - }, - { - "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}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WidgetProductListing" - } - } - } - } - } - } - }, - "/_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}$" - } - }, - { - "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": "", - "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": [ - { - "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": [ - { - "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": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - } - } - }, - "example": { - "collection": { - "lastSeen": [ - "018c19b80403709cb2cef54f70860042", - "018c19b804027291955d8f076c272d0d" - ] - } - } - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/load-temp-cart": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Load a temporary cart for the attendee", - "description": "Load a temporary cart for the attendee", - "operationId": "loadTempCart", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "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" - } - } - } - } - } - } - }, - "/_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}$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddTempDiscountRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/remove-temp-discount": { - "post": { - "tags": [ - "Appointment" - ], - "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" - } - } - } - }, - "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": [ - { - "name": "appointmentId", - "in": "path", - "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": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "example": { - "data": { - "01938f89c632709ba4d65eb53604bf5b": { - "quantity": "1" - }, - "01938f89c8647036a617b7d88e1e24f5": { - "quantity": "1" - }, - "01938f8a23d47305b1e289163cea5074": { - "quantity": "1" - } - } - } - } - } - } - } - } - } - }, - "security": [ - { - "ApiKey": [] - } - ] - } - } - }, - "components": { - "schemas": { - "success": { - "required": [ - "data" + } + }, + "components": { + "schemas": { + "success": { + "required": [ + "data" ], "properties": { "meta": { @@ -33327,12 +32231,6 @@ "description": "When the value is set to true, the product is hidden when sold out.", "type": "boolean" }, - "availableStock": { - "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", - "type": "integer", - "format": "int64", - "readOnly": true - }, "stock": { "description": "Indicates the number of products available.", "type": "integer", @@ -33552,6 +32450,13 @@ "readOnly": true, "deprecated": true }, + "availableStock": { + "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", + "type": "integer", + "format": "int64", + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -34730,12 +33635,6 @@ "description": "When the value is set to true, the product is hidden when sold out.", "type": "boolean" }, - "availableStock": { - "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", - "type": "integer", - "format": "int64", - "readOnly": true - }, "stock": { "description": "Indicates the number of products available.", "type": "integer", @@ -34955,6 +33854,13 @@ "readOnly": true, "deprecated": true }, + "availableStock": { + "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", + "type": "integer", + "format": "int64", + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -37241,6 +36147,9 @@ "$ref": "#/components/schemas/Price" } }, + "customFields": { + "type": "object" + }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "integer", @@ -37251,9 +36160,6 @@ "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -37370,6 +36276,9 @@ "$ref": "#/components/schemas/Price" } }, + "customFields": { + "type": "object" + }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "integer", @@ -37380,9 +36289,6 @@ "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -45299,6 +44205,11 @@ "customFields": { "type": "object" }, + "position": { + "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, "createdAt": { "type": "string", "format": "date-time", @@ -45503,6 +44414,11 @@ "customFields": { "type": "object" }, + "position": { + "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, "createdAt": { "type": "string", "format": "date-time", @@ -52069,111 +50985,6 @@ }, "type": "object" }, - "ConsentState": { - "type": "object", - "required": [ - "name", - "scopeName", - "identifier", - "status", - "actor", - "updatedAt", - "acceptedUntil" - ], - "properties": { - "name": { - "type": "string", - "description": "The name of the consent" - }, - "scopeName": { - "type": "string", - "description": "The scope of the consent that defines how the identifier is resolved" - }, - "identifier": { - "type": "string", - "description": "The resolved identifier of the consent" - }, - "status": { - "type": "string", - "enum": [ - "unset", - "accepted", - "revoked" - ], - "description": "The current status of the consent (requested, accepted, revoked)" - }, - "actor": { - "type": [ - "string", - "null" - ], - "description": "The user name of the user who made the consent decision. null if never updated" - }, - "updatedAt": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp of when the consent status was last updated. null if never updated" - }, - "acceptedUntil": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp until when the consent is accepted. null if never accepted" - }, - "acceptedRevision": { - "type": [ - "string", - "null" - ], - "description": "The accepted consent revision. null unless the consent is currently accepted for a revision-aware consent." - }, - "latestRevision": { - "type": [ - "string", - "null" - ], - "description": "The current latest revision defined for the consent. null when the consent does not use revisions." - } - } - }, - "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 - } - } - }, "infoConfigResponse": { "type": "object", "properties": { @@ -52366,31 +51177,240 @@ "description": "True if runtime extension management is disabled." } }, - "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": [ + "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 + } + } + }, + "MeasurementUnits": { + "type": "object", + "description": "Configuration of the measurement system", + "properties": { + "system": { + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + }, + "units": { + "type": "object", + "description": "Units used in the measurement system.", + "properties": { + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." + }, + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." + } + } + } + } + }, + "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" + ] + }, + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" } } - }, - "required": [ - "version", - "shopId", - "versionRevision", - "adminWorker", - "bundles", - "settings", - "inAppPurchases" - ], - "additionalProperties": false + } }, "businessEventsResponse": { "type": "array", @@ -52426,6 +51446,130 @@ } } }, + "OAuthScopes": { + "description": "OAuth scopes that should be requested.", + "type": "string", + "enum": [ + "write", + "user-verified", + "admin", + "write user-verified", + "write admin", + "user-verified admin", + "write user-verified admin" + ] + }, + "OAuthGrant": { + "type": "object", + "properties": { + "grant_type": { + "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", + "type": "string" + } + }, + "required": [ + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } + } + }, + "OAuthClientCredentialsGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string" + }, + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret" + ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" + }, + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "username", + "password" + ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "refresh_token" + ] + } + ] + }, "Criteria": { "type": "object", "description": "Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure)", @@ -53122,783 +52266,309 @@ "sum" ] }, - "field": { - "type": "string" - } - }, - "required": [ - "name", - "type", - "field" - ] - }, - "flowBuilderActionsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the flow action" - }, - "requirements": { - "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Extensions data of event" - } - } - } - }, - "OAuthScopes": { - "description": "OAuth scopes that should be requested.", - "type": "string", - "enum": [ - "write", - "user-verified", - "admin", - "write user-verified", - "write admin", - "user-verified admin", - "write user-verified admin" - ] - }, - "OAuthGrant": { - "type": "object", - "properties": { - "grant_type": { - "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", - "type": "string" - } - }, - "required": [ - "grant_type" - ], - "discriminator": { - "propertyName": "grant_type", - "mapping": { - "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", - "password": "#/components/schemas/OAuthPasswordGrant", - "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" - } - } - }, - "OAuthClientCredentialsGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string" - }, - "client_secret": { - "description": "Password of the client that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "client_secret" - ] - } - ] - }, - "OAuthPasswordGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scope": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "username": { - "description": "Username of the user that should be authenticated.", - "type": "string" - }, - "password": { - "description": "Password of the user that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "scope", - "username", - "password" - ] - } - ] - }, - "OAuthRefreshTokenGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scope": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "refresh_token": { - "description": "The refresh token that should be used to refresh the access token.", - "type": "string" - } - }, - "required": [ - "client_id", - "scope", - "refresh_token" - ] - } - ] - }, - "MeasurementUnits": { - "type": "object", - "description": "Configuration of the measurement system", - "properties": { - "system": { - "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." - }, - "units": { - "type": "object", - "description": "Units used in the measurement system.", - "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." - }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." - } - } - } - } - }, - "Price": { - "type": "object", - "description": "Price object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - }, - "listPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net", - "linked" - ] - }, - "regulationPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net", - "linked" - ] - } - }, - "required": [ - "currencyId", - "gross", - "net", - "linked" - ] - }, - "CartPriceQuantity": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_quantity" - ] - }, - "isCalculated": { - "type": "boolean" - }, - "listPrice": { - "$ref": "#/components/schemas/CartListPrice" - }, - "price": { - "type": "number" - }, - "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" - ] - }, - "CartDeliveryPosition": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "deliveryDate": { - "type": "object", - "properties": { - "earliest": { - "type": "string", - "format": "date-time" - }, - "latest": { - "type": "string", - "format": "date-time" - } - } - }, - "identifier": { - "type": "string" - }, - "lineItem": { - "$ref": "#/components/schemas/LineItem" - }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" + "field": { + "type": "string" } - } - }, - "LineItemType": { - "type": "string", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "discount", - "container", - "quantity", - "dsr-line-item-discount", - "dsr-cart-discount" + }, + "required": [ + "name", + "type", + "field" ] }, - "DiscountLineItemPayload": { + "ConsentState": { "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt", + "acceptedUntil" + ], "properties": { - "discountType": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { "type": "string", "enum": [ - "percentage", - "absolute" - ] + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" }, - "discountValue": { - "type": "number", - "format": "float", - "maximum": 0 + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" }, - "discountPrice": { - "type": "number", - "format": "float", - "maximum": 0 + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + }, + "acceptedUntil": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp until when the consent is accepted. null if never accepted" + }, + "acceptedRevision": { + "type": [ + "string", + "null" + ], + "description": "The accepted consent revision. null unless the consent is currently accepted for a revision-aware consent." + }, + "latestRevision": { + "type": [ + "string", + "null" + ], + "description": "The current latest revision defined for the consent. null when the consent does not use revisions." } } }, - "LineItem": { + "JoinAppointmentResponse": { "type": "object", + "description": "Includes all data you will need to attend to a appointment.", "properties": { - "children": { + "mercureSubscriberTopics": { "type": "array", "items": { - "$ref": "#/components/schemas/LineItem" - } + "type": "string", + "description": "mercure topic" + }, + "description": "The topics to which the attendee/guide can subscribe for" }, - "cover": { - "$ref": "#/components/schemas/ProductMedia" + "mercurePublisherTopic": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The topic to which the attendee/guide can send updates" }, - "dataContextHash": { - "type": "string" + "JWTMercureSubscriberToken": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The JWT mercure token to publish updates" }, - "dataTimestamp": { - "type": "string" + "mercureHubPublicUrl": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mercure hub url to connect for subscribing and updating" }, - "deliveryInformation": { - "$ref": "#/components/schemas/CartDeliveryInformation" + "JWTMercurePublisherToken": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The JWT mercure token to subscribe for updates" }, - "description": { - "type": "string" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The appointment id" }, - "good": { - "type": "boolean" + "newContextToken": { + "type": "string", + "description": "The new context token will be used in the header (sw-context-token) for calling the other routes" }, - "id": { - "type": "string" + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The created Id for the attendee" }, - "label": { - "type": "string" + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the current sales channel" }, - "modified": { - "type": "boolean" + "salesChannelName": { + "type": "string", + "description": "The name of the current sales channel" }, - "modifiedByApp": { - "type": "boolean" + "appointmentName": { + "type": "string", + "description": "The name of the appointment" }, - "payload": { - "allOf": [ + "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": [ { - "$ref": "#/components/schemas/ProductJsonApi" + "type": "string" }, { - "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", - "properties": { - "meta": { - "type": "object", - "properties": { - "attendees": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - } - } - } - } - } + "type": "null" } - } + ], + "description": "The name of the attendee" }, - "price": { - "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" - } - ] - }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true - }, - "totalPrice": { - "type": "number" - }, - "unitPrice": { - "type": "number" + "videoUserId": { + "oneOf": [ + { + "type": "string" }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } + { + "type": "null" } - }, - "required": [ - "apiAlias", - "totalPrice", - "quantity", - "unitPrice" - ] - }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" - }, - "quantity": { - "type": "number" + ], + "description": "The video user id that attendee could use" }, - "quantityInformation": { + "b2bFeatures": { "type": "object", + "description": "The b2b features that available for the appointment", "properties": { - "maxPurchase": { - "type": "number" - }, - "minPurchase": { - "type": "number" - }, - "purchaseSteps": { - "type": "number" + "quoteManagement": { + "type": "boolean", + "description": "To know if the quote management is enabled for current customer" } } - }, - "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" - ] + "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" + } }, - "CartItems": { + "Cart": { "type": "object", "properties": { - "items": { + "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" } - } - } - }, - "DynamicProductListingPageOpenedPayload": { - "required": [ - "page" - ], - "properties": { - "page": { - "type": "integer", - "description": "Current page position in the pagination" - } - } - }, - "CartDelivery": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "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" - } + "errors": { + "type": "array", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "items": { + "$ref": "#/components/schemas/CartError" } }, - "positions": { + "deliveries": { "type": "array", "items": { - "$ref": "#/components/schemas/CartDeliveryPosition" + "$ref": "#/components/schemas/CartDelivery" } }, - "shippingCosts": { - "$ref": "#/components/schemas/CalculatedPrice" + "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" + } + } + } }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - }, - "DiscountType": { - "type": "string", - "description": "Type of the discount", - "enum": [ - "percentage", - "absolute" - ] - }, - "AddTempDiscountRequestBody": { - "type": "object", - "required": [ - "discountType", - "discountValue", - "appliedItemIds" - ], - "properties": { - "discountType": { - "$ref": "#/components/schemas/DiscountType" + "modified": { + "type": "boolean" }, - "discountValue": { - "type": "number", - "description": "Value of the discount (leave it 0 if you want to remove the discount)", - "maximum": 0 + "customerComment": { + "type": "string", + "description": "A comment that can be added to the cart.", + "nullable": true }, - "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" + "affiliateCode": { + "type": "string", + "description": "An affiliate tracking code", + "nullable": true }, - "discountValue": { - "type": "number", - "description": "Value of the discount (leave it 0 if you want to remove the discount)", - "maximum": 0 + "campaignCode": { + "type": "string", + "description": "A campaign tracking code", + "nullable": true } } }, @@ -53994,230 +52664,137 @@ } } }, - "GetCartInsightsResponse": { + "CalculatedPrice": { "type": "object", - "description": "Returns aggregations for the current carts within the appointment.", + "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "cartSum": { - "type": "number", - "description": "Sum of all products from all attenddees which were added to the cart during the appointment" + "unitPrice": { + "type": "number" }, - "productCount": { - "type": "number", - "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" + "quantity": { + "type": "number" }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the shown currency" + "rawTotal": { + "type": "number" }, - "currencySymbol": { - "type": "string", - "description": "The currency symbol from the shown currency" + "totalPrice": { + "type": "number" }, - "topProducts": { - "type": "object", - "required": [ - "byQuantity", - "byRevenue" - ], - "properties": { - "byQuantity": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "object", - "properties": { - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the product" - }, - "value": { - "type": "number", - "description": "The quantity in carts of this product" - } - }, - "required": [ - "productId", - "value" + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" } }, - "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" - ] - } - } + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] } - } - }, - "example": { - "extensions": [], - "cartSum": 6770.53, - "productCount": 3, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$", - "topProducts": { - "byQuantity": [ - { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1 - }, + }, + "referencePrice": { + "oneOf": [ { - "productId": "fee3ca762be94bb49b692e359d529563", - "value": 1 + "$ref": "#/components/schemas/CartPriceReference" }, { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 1 + "type": "null" } - ], - "byRevenue": [ - { - "productId": "fee3ca762be94bb49b692e359d529563", - "value": 5333.03 - }, + ] + }, + "listPrice": { + "oneOf": [ { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1152.62 + "$ref": "#/components/schemas/CartListPrice" }, { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 284.88 + "type": "null" } ] - } - } - }, - "WidgetProductListing": { - "type": "object", - "description": "Includes all data you will need to attend to a appointment.", - "properties": { - "extensions": { - "type": "array", - "description": "List of extensions", - "default": [] - }, - "products": { - "type": "array", - "description": "List of last seen products", - "items": { - "allOf": [ - { - "$ref": "#/components/schemas/Product" - }, - { - "type": "object", - "properties": { - "customFields": { - "type": "object", - "properties": { - "wishlistAttendeeIds": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - ] - } }, - "total": { - "type": "integer", - "description": "The total number of products" + "positionPrice": { + "type": "number" }, - "page": { - "type": "integer", - "description": "The current page" + "netPrice": { + "type": "number" }, - "limit": { - "type": "integer", - "description": "The number of products per page" - } - } - }, - "GetAttendeeInsightsResponse": { - "type": "object", - "description": "Returns aggregations for the current attendees within the appointment.", - "properties": { - "attendees": { + "regulationPrice": { "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/AttendeeInsights" - } - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencySymbol": { - "type": "string" - } - }, - "example": { - "extensions": [], - "attendees": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + }, + "nullable": true }, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$" - } - }, - "VideoChatCreateStruct": { - "type": "object", - "description": "Includes all data you will need to attend to a appointment.", - "properties": { - "roomUrl": { - "type": "string", - "description": "Url of the video room in daily" + "hasRange": { + "type": "boolean" }, - "roomName": { + "variantId": { "type": "string", - "description": "Name of the video room in daily" + "format": "^[0-9a-f]{32}$", + "nullable": true }, - "userToken": { + "apiAlias": { "type": "string", - "description": "Token for the end users to connect to the daily room" + "enum": [ + "calculated_price" + ] }, - "ownerToken": { - "type": "string", - "description": "Token for the room owner (guide) to connect to the daily room" + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } } }, - "example": { - "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", - "userToken": "dummy user token", - "ownerToken": "dummy owner token", - "roomName": "rSq20mrgwsj4eIXo1u95", - "extensions": [] - } + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "referencePrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitPrice", + "positionPrice", + "netPrice", + "taxRules" + ] }, "CartError": { "type": "object", @@ -54248,472 +52825,483 @@ } } }, - "CartPriceReference": { + "LineItemType": { + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "discount", + "container", + "quantity", + "dsr-line-item-discount", + "dsr-cart-discount" + ] + }, + "DiscountLineItemPayload": { "type": "object", "properties": { - "purchaseUnit": { - "type": "number" - }, - "referenceUnit": { - "type": "number" - }, - "unitName": { - "type": "string" - }, - "price": { - "type": "number" - }, - "apiAlias": { + "discountType": { "type": "string", "enum": [ - "cart_price_reference" - ] - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } + "percentage", + "absolute" ] }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true - }, - "hasRange": { - "type": "boolean" + "discountValue": { + "type": "number", + "format": "float", + "maximum": 0 }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true + "discountPrice": { + "type": "number", + "format": "float", + "maximum": 0 } - }, - "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitName" - ] + } }, - "StateForAll": { + "LineItem": { "type": "object", "properties": { - "currentGuideProductId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "lastActiveGuideSection": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "currentPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "currentSectionId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "currentSlideAlias": { - "type": "integer", - "default": 0 + "cover": { + "$ref": "#/components/schemas/ProductMedia" }, - "currentSlideData": { - "anyOf": [ - { - "$ref": "#/components/schemas/DynamicProductListingPageOpenedPayload" - }, - { - "type": "null" - } - ] + "dataContextHash": { + "type": "string" }, - "currentDynamicPage": { - "$ref": "#/components/schemas/DynamicPageOpenedPayload" + "dataTimestamp": { + "type": "string" }, - "started": { - "type": "boolean", - "default": false + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" }, - "running": { - "type": "boolean", - "default": false + "description": { + "type": "string" }, - "ended": { - "type": "boolean", - "default": false + "good": { + "type": "boolean" }, - "startedAt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] + "id": { + "type": "string" }, - "endedAt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] + "label": { + "type": "string" }, - "accessibleFrom": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] + "modified": { + "type": "boolean" }, - "accessibleTo": { - "anyOf": [ + "modifiedByApp": { + "type": "boolean" + }, + "payload": { + "allOf": [ { - "type": "string", - "format": "date-time" + "$ref": "#/components/schemas/ProductJsonApi" }, { - "type": "null" + "type": "object", + "properties": { + "discountType": { + "type": "string", + "enum": [ + "percentage", + "absolute" + ] + }, + "discountValue": { + "type": "number", + "format": "float", + "maximum": 0 + }, + "discountPrice": { + "type": "number", + "format": "float", + "maximum": 0 + } + } } ] }, - "appointmentMode": { - "type": "string", - "enum": [ - "guided", - "self" - ] - }, - "videoAudioSettings": { - "type": "string", - "enum": [ - "both", - "none", - "audio-only" - ], - "default": "none" - }, - "videoRoomUrl": { - "type": "string", - "default": "" + "extensions": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "attendees": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + } + } + } + } + } + } + } }, - "attendeeRestrictionType": { - "anyOf": [ - { + "price": { + "type": "object", + "properties": { + "apiAlias": { "type": "string", "enum": [ - "open", - "customer", - "rules" + "calculated_price" ] }, - { - "type": "null" - } - ] - }, - "productDetailDefaultPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" + ] + } }, - { - "type": "null" - } - ] - }, - "quickviewPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] }, - { - "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", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } } + }, + "required": [ + "apiAlias", + "totalPrice", + "quantity", + "unitPrice" ] }, - "productListingDefaultPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "priceDefinition": { + "$ref": "#/components/schemas/CartPriceQuantity" + }, + "quantity": { + "type": "number" + }, + "quantityInformation": { + "type": "object", + "properties": { + "maxPurchase": { + "type": "number" }, - { - "type": "null" + "minPurchase": { + "type": "number" + }, + "purchaseSteps": { + "type": "number" } - ] + } }, - "broadcastMode": { - "type": "boolean", - "default": false + "referencedId": { + "type": "string" }, - "viewMode": { - "type": "string", - "enum": [ - "onlyYou", - "presentation", - "videoGrid" - ], - "default": "presentation" + "removable": { + "type": "boolean" }, - "allowScreenSharing": { - "type": "boolean", - "default": false + "stackable": { + "type": "boolean" }, - "extensions": { + "states": { "type": "array", - "default": [] + "items": { + "type": "string", + "enum": [ + "is-physical", + "is-download" + ] + } + }, + "type": { + "$ref": "#/components/schemas/LineItemType" + }, + "uniqueIdentifier": { + "type": "string" } - } + }, + "required": [ + "id", + "type" + ] }, - "StateForGuides": { + "CartItems": { "type": "object", "properties": { - "clients": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "inactiveClients": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "guides": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "videoGuideToken": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "quickViewState": { + "items": { "type": "array", "items": { - "type": "string" - }, - "default": [] + "$ref": "#/components/schemas/LineItem" + } + } + } + }, + "AbstractDynamicPageOpenedPayload": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of the current dynamic page" }, - "extensions": { - "type": "array", - "default": [] + "opened": { + "type": "boolean", + "default": true } } }, - "CalculatedPrice": { + "GetCartInsightsResponse": { "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", + "description": "Returns aggregations for the current carts within the appointment.", "properties": { - "unitPrice": { - "type": "number" + "cartSum": { + "type": "number", + "description": "Sum of all products from all attenddees which were added to the cart during the appointment" }, - "quantity": { - "type": "number" + "productCount": { + "type": "number", + "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" }, - "rawTotal": { - "type": "number" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the shown currency" }, - "totalPrice": { - "type": "number" + "currencySymbol": { + "type": "string", + "description": "The currency symbol from the shown currency" }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_tax_calculated" + "topProducts": { + "type": "object", + "required": [ + "byQuantity", + "byRevenue" + ], + "properties": { + "byQuantity": { + "type": "array", + "uniqueItems": true, + "items": { + "type": "object", + "properties": { + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the product" + }, + "value": { + "type": "number", + "description": "The quantity in carts of this product" + } + }, + "required": [ + "productId", + "value" ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" } }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] + "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" + ] + } + } } - }, - "referencePrice": { - "oneOf": [ + } + }, + "example": { + "extensions": [], + "cartSum": 6770.53, + "productCount": 3, + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$", + "topProducts": { + "byQuantity": [ + { + "productId": "01ae0dee60ea48fdafaf881b96361d59", + "value": 1 + }, { - "$ref": "#/components/schemas/CartPriceReference" + "productId": "fee3ca762be94bb49b692e359d529563", + "value": 1 }, { - "type": "null" + "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", + "value": 1 } - ] - }, - "listPrice": { - "oneOf": [ + ], + "byRevenue": [ { - "$ref": "#/components/schemas/CartListPrice" + "productId": "fee3ca762be94bb49b692e359d529563", + "value": 5333.03 }, { - "type": "null" + "productId": "01ae0dee60ea48fdafaf881b96361d59", + "value": 1152.62 + }, + { + "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", + "value": 284.88 } ] - }, - "positionPrice": { - "type": "number" - }, - "netPrice": { - "type": "number" - }, - "regulationPrice": { + } + } + }, + "CartDelivery": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { "type": "object", "properties": { - "price": { - "type": "number" + "earliest": { + "type": "string", + "format": "date-time" }, + "latest": { + "type": "string", + "format": "date-time" + } + } + }, + "location": { + "type": "object", + "properties": { "apiAlias": { "type": "string", "enum": [ - "cart_regulation_price" + "cart_delivery_shipping_location" ] + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "state": { + "$ref": "#/components/schemas/CountryState" } - }, - "nullable": true - }, - "hasRange": { - "type": "boolean" - }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true - }, - "apiAlias": { - "type": "string", - "enum": [ - "calculated_price" - ] + } }, - "taxRules": { + "positions": { "type": "array", - "description": "Currently active tax rules and/or rates", "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } + "$ref": "#/components/schemas/CartDeliveryPosition" } - } - }, - "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "referencePrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitPrice", - "positionPrice", - "netPrice", - "taxRules" - ] - }, - "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" + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" } } }, @@ -54799,116 +53387,53 @@ "apiAlias" ] }, - "Cart": { + "WidgetProductListing": { "type": "object", + "description": "Includes all data you will need to attend to a appointment.", "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": { + "extensions": { "type": "array", - "items": { - "$ref": "#/components/schemas/CartDelivery" - } + "description": "List of extensions", + "default": [] }, - "transactions": { - "description": "A list of all payment transactions associated with the current cart.", + "products": { "type": "array", + "description": "List of last seen products", "items": { - "type": "object", - "properties": { - "paymentMethodId": { - "type": "string" + "allOf": [ + { + "$ref": "#/components/schemas/Product" }, - "amount": { - "$ref": "#/components/schemas/CalculatedPrice" + { + "type": "object", + "properties": { + "customFields": { + "type": "object", + "properties": { + "wishlistAttendeeIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } } - } + ] } }, - "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 - } - } - }, - "AbstractDynamicPageOpenedPayload": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "description": "The type of the current dynamic page" - }, - "opened": { - "type": "boolean", - "default": true - } - } - }, - "AttendeeInsights": { - "type": "object", - "description": "Attendee Insights", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Id of the attendee" + "total": { + "type": "integer", + "description": "The total number of products" }, - "cartSum": { - "type": "number", - "description": "Sum of the cart net in base currency" + "page": { + "type": "integer", + "description": "The current page" }, - "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 + "limit": { + "type": "integer", + "description": "The number of products per page" } } }, @@ -55357,59 +53882,370 @@ "apiAlias": "cms_section" } ], - "translations": null, - "cssClass": null, - "config": null, - "previewMediaId": null, - "previewMedia": null, - "landingPages": null, - "id": "33e88c7994fa4cf79a1265e5105b93b2", - "customFields": null, - "apiAlias": "cms_page" + "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" + } + }, + "StateForGuides": { + "type": "object", + "properties": { + "clients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "inactiveClients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "guides": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "videoGuideToken": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "quickViewState": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "extensions": { + "type": "array", + "default": [] + } + } + }, + "VideoChatCreateStruct": { + "type": "object", + "description": "Includes all data you will need to attend to a appointment.", + "properties": { + "roomUrl": { + "type": "string", + "description": "Url of the video room in daily" + }, + "roomName": { + "type": "string", + "description": "Name of the video room in daily" + }, + "userToken": { + "type": "string", + "description": "Token for the end users to connect to the daily room" + }, + "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": [] + } + }, + "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" + } + } + }, + "DynamicProductListingPageOpenedPayload": { + "required": [ + "page" + ], + "properties": { + "page": { + "type": "integer", + "description": "Current page position in the pagination" + } + } + }, + "StateForAll": { + "type": "object", + "properties": { + "currentGuideProductId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "lastActiveGuideSection": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "currentPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "currentSectionId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "currentSlideAlias": { + "type": "integer", + "default": 0 + }, + "currentSlideData": { + "anyOf": [ + { + "$ref": "#/components/schemas/DynamicProductListingPageOpenedPayload" + }, + { + "type": "null" + } + ] + }, + "currentDynamicPage": { + "$ref": "#/components/schemas/DynamicPageOpenedPayload" + }, + "started": { + "type": "boolean", + "default": false + }, + "running": { + "type": "boolean", + "default": false + }, + "ended": { + "type": "boolean", + "default": false + }, + "startedAt": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "endedAt": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "accessibleFrom": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "accessibleTo": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "appointmentMode": { + "type": "string", + "enum": [ + "guided", + "self" + ] + }, + "videoAudioSettings": { + "type": "string", + "enum": [ + "both", + "none", + "audio-only" + ], + "default": "none" }, - "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" + "videoRoomUrl": { + "type": "string", + "default": "" }, - "apiAlias": "pwa_page_result" + "attendeeRestrictionType": { + "anyOf": [ + { + "type": "string", + "enum": [ + "open", + "customer", + "rules" + ] + }, + { + "type": "null" + } + ] + }, + "productDetailDefaultPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "quickviewPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "productListingDefaultPageId": { + "anyOf": [ + { + "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": [] + } } }, "PresentationCmsPage": { @@ -55440,167 +54276,271 @@ } ] }, - "JoinAppointmentResponse": { + "CartPriceReference": { "type": "object", - "description": "Includes all data you will need to attend to a appointment.", "properties": { - "mercureSubscriberTopics": { - "type": "array", - "items": { - "type": "string", - "description": "mercure topic" - }, - "description": "The topics to which the attendee/guide can subscribe for" + "purchaseUnit": { + "type": "number" }, - "mercurePublisherTopic": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The topic to which the attendee/guide can send updates" + "referenceUnit": { + "type": "number" }, - "JWTMercureSubscriberToken": { + "unitName": { + "type": "string" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_reference" + ] + }, + "listPrice": { "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/CartListPrice" }, { "type": "null" } - ], - "description": "The JWT mercure token to publish updates" + ] }, - "mercureHubPublicUrl": { - "oneOf": [ - { - "type": "string" + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" }, - { - "type": "null" + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] } - ], - "description": "The mercure hub url to connect for subscribing and updating" + }, + "nullable": true }, - "JWTMercurePublisherToken": { - "oneOf": [ - { - "type": "string" + "hasRange": { + "type": "boolean" + }, + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true + } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] + }, + "CartDeliveryPosition": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" }, - { - "type": "null" + "latest": { + "type": "string", + "format": "date-time" } - ], - "description": "The JWT mercure token to subscribe for updates" + } }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The appointment id" + "identifier": { + "type": "string" }, - "newContextToken": { - "type": "string", - "description": "The new context token will be used in the header (sw-context-token) for calling the other routes" + "lineItem": { + "$ref": "#/components/schemas/LineItem" }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The created Id for the attendee" + "price": { + "$ref": "#/components/schemas/CalculatedPrice" + } + } + }, + "GetAttendeeInsightsResponse": { + "type": "object", + "description": "Returns aggregations for the current attendees within the appointment.", + "properties": { + "attendees": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/AttendeeInsights" + } }, - "salesChannelId": { + "currencyId": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the current sales channel" + "pattern": "^[0-9a-f]{32}$" }, - "salesChannelName": { - "type": "string", - "description": "The name of the current sales channel" + "currencySymbol": { + "type": "string" + } + }, + "example": { + "extensions": [], + "attendees": { + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } }, - "appointmentName": { - "type": "string", - "description": "The name of the appointment" + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$" + } + }, + "DynamicPageOpenedPayload": { + "allOf": [ + { + "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" + } + ] + }, + "DiscountType": { + "type": "string", + "description": "Type of the discount", + "enum": [ + "percentage", + "absolute" + ] + }, + "AddTempDiscountRequestBody": { + "type": "object", + "required": [ + "discountType", + "discountValue", + "appliedItemIds" + ], + "properties": { + "discountType": { + "$ref": "#/components/schemas/DiscountType" }, - "presentationGuideMode": { + "discountValue": { + "type": "number", + "description": "Value of the discount (leave it 0 if you want to remove the discount)", + "maximum": 0 + }, + "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" + }, + "discountValue": { + "type": "number", + "description": "Value of the discount (leave it 0 if you want to remove the discount)", + "maximum": 0 + } + } + }, + "CartPriceQuantity": { + "type": "object", + "properties": { + "apiAlias": { "type": "string", "enum": [ - "self", - "guided" - ], - "description": "The type of the appointment" + "cart_price_quantity" + ] }, - "isPreview": { - "type": "boolean", - "description": "To see if it's a preview appointment" + "isCalculated": { + "type": "boolean" }, - "attendeeName": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The name of the attendee" + "listPrice": { + "$ref": "#/components/schemas/CartListPrice" }, - "videoUserId": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The video user id that attendee could use" + "price": { + "type": "number" }, - "b2bFeatures": { - "type": "object", - "description": "The b2b features that available for the appointment", + "quantity": { + "type": "number" + }, + "regulationPrice": { "properties": { - "quoteManagement": { - "type": "boolean", - "description": "To know if the quote management is enabled for current customer" + "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" } }, - "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" - } + "required": [ + "apiAlias" + ] }, - "DynamicPageOpenedPayload": { - "allOf": [ - { - "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" + "AttendeeInsights": { + "type": "object", + "description": "Attendee Insights", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Id of the attendee" + }, + "cartSum": { + "type": "number", + "description": "Sum of the cart net in base currency" + }, + "productCount": { + "type": "number", + "description": "Sum of all quantities in the cart which were added during the appointment" } - ] + }, + "example": { + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } + } } }, "responses": { diff --git a/SwagDigitalSalesRooms-adminapi.summary.json b/SwagDigitalSalesRooms-adminapi.summary.json index 6faf772..bf05ff1 100644 --- a/SwagDigitalSalesRooms-adminapi.summary.json +++ b/SwagDigitalSalesRooms-adminapi.summary.json @@ -29,8 +29,6 @@ "/aggregate/dsr-interaction", "/aggregate/dsr-presentation", "/aggregate/dsr-presentation-cms-page", - "/aggregate/sales-channel-tracking-customer", - "/aggregate/sales-channel-tracking-order", "/dsr-appointment", "/dsr-appointment-attendee", "/dsr-appointment-attendee/{id}", @@ -49,10 +47,6 @@ "/dsr-presentation-cms-page", "/dsr-presentation-cms-page/{id}", "/dsr-presentation/{id}", - "/sales-channel-tracking-customer", - "/sales-channel-tracking-customer/{id}", - "/sales-channel-tracking-order", - "/sales-channel-tracking-order/{id}", "/search/dsr-appointment", "/search/dsr-appointment-attendee", "/search/dsr-appointment-request", @@ -61,9 +55,7 @@ "/search/dsr-cms-slide", "/search/dsr-interaction", "/search/dsr-presentation", - "/search/dsr-presentation-cms-page", - "/search/sales-channel-tracking-customer", - "/search/sales-channel-tracking-order" + "/search/dsr-presentation-cms-page" ], "schemas": [ "AbstractDynamicPageOpenedPayload",