From 1e804ab9f480cf10fb2cd3a47cb7338cedca7f90 Mon Sep 17 00:00:00 2001 From: shopwareBot Date: Fri, 3 Apr 2026 10:17:58 +0000 Subject: [PATCH] [create-pull-request] automated change --- SwagDigitalSalesRooms-adminapi.json | 7679 ++++++++++++------- SwagDigitalSalesRooms-adminapi.summary.json | 16 +- 2 files changed, 4711 insertions(+), 2984 deletions(-) diff --git a/SwagDigitalSalesRooms-adminapi.json b/SwagDigitalSalesRooms-adminapi.json index d7100d9..64194b2 100644 --- a/SwagDigitalSalesRooms-adminapi.json +++ b/SwagDigitalSalesRooms-adminapi.json @@ -4884,293 +4884,216 @@ } } }, - "/_action/user/logout": { - "post": { - "tags": [ - "Authorization & Authentication" - ], - "summary": "Logout the current user", - "description": "Revokes all server-side refresh tokens for the currently authenticated administration user and returns a no content response.", - "operationId": "userLogout", - "responses": { - "204": { - "description": "Tokens have been revoked successfully." - }, - "401": { - "description": "Unauthorized - the access token is missing or invalid." - }, - "403": { - "description": "The authenticated source does not have a user ID associated." - } - } - } - }, - "/app-system/shop/verify": { + "/sales-channel-tracking-customer": { "get": { "tags": [ - "App System", - "Public" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Verify a shop's APP_URL", - "description": "Used to verify that a shop's APP_URL points to its self. The passed run ID and token are used to query the cache. It returns 204 no content if the given token can be verified using the run id.", - "operationId": "verifyAppUrl", + "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", "parameters": [ { - "name": "runId", + "name": "limit", "in": "query", - "description": "A unique identifier used to look up the token", - "required": true, + "description": "Max amount of resources to be returned in a page", "schema": { - "type": "string" + "type": "integer" } }, { - "name": "token", + "name": "page", "in": "query", - "description": "A unique identifier", - "required": true, + "description": "The page to be returned", "schema": { - "type": "string" + "type": "integer" } - } - ], - "responses": { - "204": { - "description": "An empty response signalling successful verification." }, - "400": { - "description": "Malformed request or unsuccessful verification." - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/join-as-guide": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Join a meeting as a guide", - "description": "This route is used to join appointment as guide.", - "operationId": "joinAppointmentAsGuide", - "parameters": [ { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } } ], "responses": { "200": { - "description": "", + "description": "List of Sales Channel Tracking Customer resources.", "content": { - "application/json": { + "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/JoinAppointmentResponse" + "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" + } + } + } + ] + } + } + } + ] } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/start": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Start a presentation for a appointment", - "description": "Complete all needed data start the presentation", - "operationId": "startAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "204": { - "description": "" - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/end": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "End a presentation for a appointment", - "description": "Complete all needed data and remove unneeded to close the presentation", - "operationId": "endAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/sw-context-token": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get the sw-context-token for a attendee", - "description": "Returns the context-token for the given attendee if the attendee granted the permission for the cart", - "operationId": "getAttendeeToken", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "The sw-context-token from the attendee", - "content": { + }, "application/json": { "schema": { "type": "object", "properties": { - "attendee-sw-context-token": { - "type": "string" + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } } - }, - "example": { - "attendee-sw-context-token": "context token of attendee" } } } } + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/dsr/appointment/{appointmentId}/instant-listing": { + }, "post": { "tags": [ - "Appointment" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Add a instant listing to the presentation", - "description": "Add a page as the instant listing to the presentation", - "operationId": "addInstantListing", + "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", "parameters": [ { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "basic", + "detail" + ] } } ], "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" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } } } }, "responses": { - "201": { - "description": "Created a new instant listing", + "200": { + "description": "Detail of SalesChannelTrackingCustomer", "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": { - "index": { - "type": "integer", - "description": "The current index of the instant listing which is created by this request" + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" } - }, - "example": { - "index": 1 } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/sales-channel-tracking-customer": { + "post": { "tags": [ - "Appointment" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Update a instant listing from the presentation", - "description": "Updates the products for the given listing", - "operationId": "updateInstantListing", + "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", "parameters": [ { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "0", + "1" + ], + "default": "1" } } ], @@ -5179,104 +5102,76 @@ "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/Criteria" } } } }, "responses": { "200": { - "description": "Updated the instant listing", + "description": "List of SalesChannelTrackingCustomer", "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": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the instant listing page" + "total": { + "type": "integer" }, - "pickedProductIds": { + "data": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which are picked for the instant listing" - }, - "title": { - "type": "string", - "description": "The title of the instant listing" + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } } - }, - "example": { - "id": "018c3e5ffd3a70899fa1321bf7e2a7f7", - "pickedProductIds": [ - "018c19b80403709cb2cef54f70860042", - "018c19b804027291955d8f076c272d0d" - ], - "title": "Default Digital Sales Rooms product listing page" } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/{appointmentId}/presentation/state": { + "/sales-channel-tracking-customer/{id}": { "get": { "tags": [ - "Appointment" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Get the current presentation state", - "description": "Returns the presentation state for all and the guide", - "operationId": "getGuidePresentationState", + "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", "parameters": [ { - "name": "appointmentId", + "name": "id", "in": "path", - "description": "Appointment id", + "description": "Identifier for the sales_channel_tracking_customer", "required": true, "schema": { "type": "string", @@ -5286,413 +5181,545 @@ ], "responses": { "200": { - "description": "", + "description": "Detail of SalesChannelTrackingCustomer", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GuidePresentationStateResponse" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } } } } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/dsr/appointment/{appointmentId}/video-room": { - "post": { + }, + "delete": { "tags": [ - "Appointment" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Create a video room", - "description": "Creates a video room on the remote video tool", - "operationId": "createVideoRoom", + "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", "parameters": [ { - "name": "appointmentId", + "name": "id", "in": "path", - "description": "Appointment id", + "description": "Identifier for the sales_channel_tracking_customer", "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": { - "schema": { - "$ref": "#/components/schemas/VideoChatCreateStruct" - } - } - } + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } }, - "delete": { + "patch": { "tags": [ - "Appointment" + "Sales Channel Tracking Customer", + "Experimental" ], - "summary": "Delete a video room", - "description": "Delete a video room and tokens on the remote video tool", - "operationId": "deleteVideoRoom", + "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", "parameters": [ { - "name": "appointmentId", + "name": "id", "in": "path", - "description": "Appointment id", + "description": "Identifier for the sales_channel_tracking_customer", "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 Customer resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } + } + }, "responses": { "200": { - "description": "", + "description": "Detail of SalesChannelTrackingCustomer", "content": { - "application/json": [] - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get attendee insights", - "description": "Get attendee insights for the given appointment", - "operationId": "getAttendeeInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { + "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/GetAttendeeInsightsResponse" + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } + } + ] } - } - } - } - } - } - }, - "/_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" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics": { - "get": { + "/aggregate/sales-channel-tracking-customer": { + "post": { "tags": [ - "Appointment" + "Sales Channel Tracking Customer", + "Experimental" ], - "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" + "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" + ] + } } } - ], + }, "responses": { "200": { - "description": "", + "description": "List of SalesChannelTrackingCustomer", "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": { - "$ref": "#/components/schemas/Cart" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics": { + "/sales-channel-tracking-order": { "get": { "tags": [ - "Appointment" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Get last seen products insights", - "description": "Get last seen products of all attendees for the given appointment", - "operationId": "getLastSeenProductsInsights", + "summary": "List with basic information of Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingOrderList", "parameters": [ - { - "name": "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", + "description": "Max amount of resources to be returned in a page", "schema": { - "type": "integer", - "default": 10 + "type": "integer" } }, { "name": "page", "in": "query", - "description": "The page of the products which should be returned", + "description": "The page to be returned", "schema": { - "type": "integer", - "default": 1 + "type": "integer" } }, { - "name": "term", + "name": "query", "in": "query", - "description": "The search term for the products", + "description": "Encoded SwagQL in JSON", "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": "", + "description": "List of Sales Channel Tracking Order resources.", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/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": { - "$ref": "#/components/schemas/WidgetProductListing" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } + } } } } + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics": { - "get": { + }, + "post": { "tags": [ - "Appointment" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Get wishlist insights", - "description": "Get wishlist of all the attendees for the given appointment", - "operationId": "getWishlistInsights", + "summary": "Create a new Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "createSalesChannelTrackingOrder", "parameters": [ { - "name": "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", + "name": "_response", "in": "query", - "description": "The attendee id for which the wishlist products should be returned", + "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "basic", + "detail" + ] } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } + } + }, "responses": { "200": { - "description": "", + "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": { - "$ref": "#/components/schemas/WidgetProductListing" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/attendee/{attendeeId}/remove": { + "/search/sales-channel-tracking-order": { "post": { "tags": [ - "Appointment" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Remove an attendee from the appointment", - "description": "Remove an attendee from the appointment", - "operationId": "removeAttendee", + "summary": "Search for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "searchSalesChannelTrackingOrder", "parameters": [ { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "0", + "1" + ], + "default": "1" } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, "responses": { "200": { - "description": "", + "description": "List of SalesChannelTrackingOrder", "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": { - "message": { - "type": "string" + "total": { + "type": "integer" }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the removed attendee" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } } - }, - "example": { - "message": "Attendee removed successfully", - "attendeeId": "018c19b80403709cb2cef54f70860042" } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids": { + "/sales-channel-tracking-order/{id}": { "get": { "tags": [ - "Appointment" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Get ids of last seen products", - "description": "Get all product ids of that attendee has seen", - "operationId": "getLastSeenProductIds", + "summary": "Detailed information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "getSalesChannelTrackingOrder", "parameters": [ { - "name": "attendeeId", + "name": "id", "in": "path", - "description": "Attendee id", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -5702,53 +5729,61 @@ ], "responses": { "200": { - "description": "", + "description": "Detail of SalesChannelTrackingOrder", "content": { - "application/json": { + "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "collection": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { "type": "object", "properties": { - "lastSeen": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } - }, - "example": { - "collection": { - "lastSeen": [ - "018c19b80403709cb2cef54f70860042", - "018c19b804027291955d8f076c272d0d" - ] + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" } } } } } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/load-temp-cart": { - "get": { + }, + "delete": { "tags": [ - "Appointment" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Load a temporary cart for the attendee", - "description": "Load a temporary cart for the attendee", - "operationId": "loadTempCart", + "summary": "Delete a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "deleteSalesChannelTrackingOrder", "parameters": [ { - "name": "attendeeId", + "name": "id", "in": "path", - "description": "Attendee id", + "description": "Identifier for the sales_channel_tracking_order", "required": true, "schema": { "type": "string", @@ -5756,85 +5791,208 @@ } }, { - "name": "sw-context-token", - "in": "header", - "description": "Contains sw-context-token value", + "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": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/add-temp-discount": { - "post": { + }, + "patch": { "tags": [ - "Appointment" + "Sales Channel Tracking Order", + "Experimental" ], - "summary": "Add discount to the temp cart", - "description": "Add discount to the temp cart", - "operationId": "addTempDiscount", + "summary": "Partially update information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.7.9.0", + "operationId": "updateSalesChannelTrackingOrder", "parameters": [ { - "name": "attendeeId", + "name": "id", "in": "path", - "description": "Attendee id", + "description": "Identifier for the sales_channel_tracking_order", "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": { - "$ref": "#/components/schemas/AddTempDiscountRequestBody" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "", + "description": "List of SalesChannelTrackingOrder", "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": { - "$ref": "#/components/schemas/Cart" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelTrackingOrder" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/attendee/{attendeeId}/remove-temp-discount": { + "/_action/dsr/appointment/{appointmentId}/join-as-guide": { "post": { "tags": [ "Appointment" ], - "summary": "Remove all discount from the temp cart", - "description": "Remove all discount from the temp cart", - "operationId": "removeTempDiscount", + "summary": "Join a meeting as a guide", + "description": "This route is used to join appointment as guide.", + "operationId": "joinAppointmentAsGuide", "parameters": [ { - "name": "attendeeId", + "name": "appointmentId", "in": "path", - "description": "Attendee id", + "description": "Appointment id", "required": true, "schema": { "type": "string", @@ -5848,7 +6006,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Cart" + "$ref": "#/components/schemas/JoinAppointmentResponse" } } } @@ -5856,14 +6014,68 @@ } } }, - "/_action/dsr/appointment/attendee/{attendeeId}/apply-temp-discount": { + "/_action/dsr/appointment/{appointmentId}/start": { "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", + "summary": "Start a presentation for a appointment", + "description": "Complete all needed data start the presentation", + "operationId": "startAppointment", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "204": { + "description": "" + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/end": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "End a presentation for a appointment", + "description": "Complete all needed data and remove unneeded to close the presentation", + "operationId": "endAppointment", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/sw-context-token": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get the sw-context-token for a attendee", + "description": "Returns the context-token for the given attendee if the attendee granted the permission for the cart", + "operationId": "getAttendeeToken", "parameters": [ { "name": "attendeeId", @@ -5878,11 +6090,19 @@ ], "responses": { "200": { - "description": "", + "description": "The sw-context-token from the attendee", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Cart" + "type": "object", + "properties": { + "attendee-sw-context-token": { + "type": "string" + } + }, + "example": { + "attendee-sw-context-token": "context token of attendee" + } } } } @@ -5890,19 +6110,19 @@ } } }, - "/_action/dsr/appointment/attendee/{attendeeId}/add-cart-discount": { + "/_action/dsr/appointment/{appointmentId}/instant-listing": { "post": { "tags": [ "Appointment" ], - "summary": "Add discount to the attendee cart", - "description": "Add discount to the attendee cart", - "operationId": "addCartDiscount", + "summary": "Add a instant listing to the presentation", + "description": "Add a page as the instant listing to the presentation", + "operationId": "addInstantListing", "parameters": [ { - "name": "attendeeId", + "name": "appointmentId", "in": "path", - "description": "Attendee id", + "description": "Appointment id", "required": true, "schema": { "type": "string", @@ -5915,18 +6135,164 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AddCartDiscountRequestBody" + "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", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "addProductIds", + "removeProductIds", + "currentPageGroupId" + ], + "properties": { + "addProductIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "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": "", + "description": "Updated the instant listing", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Cart" + "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" + } } } } @@ -5934,29 +6300,53 @@ } } }, - "/_action/dsr/appointment/{appointmentId}/shopping-lists/{shoppingListId}": { - "post": { + "/_action/dsr/appointment/{appointmentId}/presentation/state": { + "get": { "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", + "summary": "Get the current presentation state", + "description": "Returns the presentation state for all and the guide", + "operationId": "getGuidePresentationState", "parameters": [ { "name": "appointmentId", "in": "path", - "description": "The appointment id you are joining", + "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - }, + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidePresentationStateResponse" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/video-room": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Create a video room", + "description": "Creates a video room on the remote video tool", + "operationId": "createVideoRoom", + "parameters": [ { - "name": "shoppingListId", + "name": "appointmentId", "in": "path", - "description": "The shopping list id you want to load", + "description": "Appointment id", "required": true, "schema": { "type": "string", @@ -5970,418 +6360,1064 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "example": { - "data": { - "01938f89c632709ba4d65eb53604bf5b": { - "quantity": "1" - }, - "01938f89c8647036a617b7d88e1e24f5": { - "quantity": "1" - }, - "01938f8a23d47305b1e289163cea5074": { - "quantity": "1" - } - } - } - } - } + "$ref": "#/components/schemas/VideoChatCreateStruct" } } } } - }, - "security": [ + } + }, + "delete": { + "tags": [ + "Appointment" + ], + "summary": "Delete a video room", + "description": "Delete a video room and tokens on the remote video tool", + "operationId": "deleteVideoRoom", + "parameters": [ { - "ApiKey": [] + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } - ] - } - } - }, - "components": { - "schemas": { - "success": { - "required": [ - "data" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "description": "Link members related to the primary data.", - "allOf": [ - { - "$ref": "#/components/schemas/links" - }, - { - "$ref": "#/components/schemas/pagination" + "responses": { + "200": { + "description": "", + "content": { + "application/json": [] + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get attendee insights", + "description": "Get attendee insights for the given appointment", + "operationId": "getAttendeeInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAttendeeInsightsResponse" + } } - ] - }, - "data": { - "$ref": "#/components/schemas/data" - }, - "included": { - "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + } } - }, - "type": "object", - "additionalProperties": false - }, - "failure": { - "required": [ - "errors" + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/cart-insights": { + "get": { + "tags": [ + "Appointment" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/error" - }, - "uniqueItems": true + "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}$" + } } - }, - "type": "object", - "additionalProperties": false - }, - "info": { - "required": [ - "meta" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "jsonapi": { - "$ref": "#/components/schemas/jsonapi" + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetCartInsightsResponse" + } + } + } } - }, - "type": "object" - }, - "meta": { - "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", - "type": "object", - "additionalProperties": true - }, - "data": { - "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", - "oneOf": [ + } + } + }, + "/_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": [ { - "$ref": "#/components/schemas/resource" + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, { - "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "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" + } } - ] - }, - "resource": { - "description": "\"Resource objects\" appear in a JSON API document to represent resources.", - "required": [ - "type", - "id" ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "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}$" + } }, - "attributes": { - "$ref": "#/components/schemas/attributes" + { + "name": "limit", + "in": "query", + "description": "The limit of the products which should be returned", + "schema": { + "type": "integer", + "default": 10 + } }, - "relationships": { - "$ref": "#/components/schemas/relationships" + { + "name": "page", + "in": "query", + "description": "The page of the products which should be returned", + "schema": { + "type": "integer", + "default": 1 + } }, - "links": { - "$ref": "#/components/schemas/links" + { + "name": "term", + "in": "query", + "description": "The search term for the products", + "schema": { + "type": "string" + } }, - "meta": { - "$ref": "#/components/schemas/meta" + { + "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}$" + } } - }, - "type": "object" - }, - "relationshipLinks": { - "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", - "properties": { - "self": { - "allOf": [ - { - "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", - "type": "array", - "items": { - "type": "object" + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WidgetProductListing" } - }, - { - "$ref": "#/components/schemas/link" } - ] - }, - "related": { - "$ref": "#/components/schemas/link" + } } - }, - "type": "object", - "additionalProperties": true - }, - "links": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/link" } - }, - "link": { - "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", - "oneOf": [ + } + }, + "/_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": [ { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, { - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - "meta": { - "$ref": "#/components/schemas/meta" - } + "name": "limit", + "in": "query", + "description": "The limit of the products which should be returned", + "schema": { + "type": "integer", + "default": 10 } - } - ] - }, - "attributes": { - "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", - "type": "object", - "additionalProperties": true - }, - "relationships": { - "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", - "type": "object", - "anyOf": [ + }, { - "required": [ - "data" - ] + "name": "page", + "in": "query", + "description": "The page of the products which should be returned", + "schema": { + "type": "integer", + "default": 1 + } }, { - "required": [ - "meta" - ] + "name": "term", + "in": "query", + "description": "The search term for the wishlist products", + "schema": { + "type": "string" + } }, { - "required": [ - "links" - ] + "name": "order", + "in": "query", + "description": "The order of the wishlist products", + "schema": { + "type": "string" + } }, { - "type": "object", - "properties": { - "links": { - "$ref": "#/components/schemas/relationshipLinks" - }, - "data": { - "description": "Member, whose value represents \"resource linkage\".", - "oneOf": [ - { - "$ref": "#/components/schemas/relationshipToOne" + "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" + } }, - { - "$ref": "#/components/schemas/relationshipToMany" + "example": { + "message": "Attendee removed successfully", + "attendeeId": "018c19b80403709cb2cef54f70860042" } - ] + } } } } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids": { + "get": { + "tags": [ + "Appointment" ], - "additionalProperties": false - }, - "relationshipToOne": { - "allOf": [ - { - "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." - }, + "summary": "Get ids of last seen products", + "description": "Get all product ids of that attendee has seen", + "operationId": "getLastSeenProductIds", + "parameters": [ { - "$ref": "#/components/schemas/linkage" + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } - ] - }, - "relationshipToMany": { - "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", - "type": "array", - "items": { - "$ref": "#/components/schemas/linkage" - }, - "uniqueItems": true - }, - "linkage": { - "description": "The \"type\" and \"id\" to non-empty members.", - "required": [ - "type", - "id" ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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}$" + } }, - "meta": { - "$ref": "#/components/schemas/meta" + { + "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" + } + } } }, - "type": "object", - "additionalProperties": false - }, - "pagination": { + "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" + ], "properties": { - "first": { - "description": "The first page of data", - "type": "string", - "format": "uri-reference" + "meta": { + "$ref": "#/components/schemas/meta" }, - "last": { - "description": "The last page of data", - "type": "string", - "format": "uri-reference" + "links": { + "description": "Link members related to the primary data.", + "allOf": [ + { + "$ref": "#/components/schemas/links" + }, + { + "$ref": "#/components/schemas/pagination" + } + ] }, - "prev": { - "description": "The previous page of data", - "type": "string", - "format": "uri-reference" + "data": { + "$ref": "#/components/schemas/data" }, - "next": { - "description": "The next page of data", - "type": "string", - "format": "uri-reference" + "included": { + "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true } }, - "type": "object" + "type": "object", + "additionalProperties": false }, - "jsonapi": { - "description": "An object describing the server's implementation", + "failure": { + "required": [ + "errors" + ], "properties": { - "version": { - "type": "string" - }, "meta": { "$ref": "#/components/schemas/meta" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/error" + }, + "uniqueItems": true } }, "type": "object", "additionalProperties": false }, - "error": { + "info": { + "required": [ + "meta" + ], "properties": { - "id": { - "type": "string", - "description": "A unique identifier for this particular occurrence of the problem." + "meta": { + "$ref": "#/components/schemas/meta" }, "links": { "$ref": "#/components/schemas/links" }, - "status": { - "type": "string", - "description": "The HTTP status code applicable to this problem, expressed as a string value." + "jsonapi": { + "$ref": "#/components/schemas/jsonapi" + } + }, + "type": "object" + }, + "meta": { + "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", + "type": "object", + "additionalProperties": true + }, + "data": { + "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", + "oneOf": [ + { + "$ref": "#/components/schemas/resource" }, - "code": { - "type": "string", - "description": "An application-specific error code, expressed as a string value." + { + "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + ] + }, + "resource": { + "description": "\"Resource objects\" appear in a JSON API document to represent resources.", + "required": [ + "type", + "id" + ], + "properties": { + "type": { + "type": "string" }, - "title": { - "type": "string", - "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization." + "id": { + "type": "string" }, - "detail": { - "type": "string", - "description": "A human-readable explanation specific to this occurrence of the problem." + "attributes": { + "$ref": "#/components/schemas/attributes" }, - "description": { - "type": "string", - "description": "A human-readable description of the problem." + "relationships": { + "$ref": "#/components/schemas/relationships" }, - "source": { - "type": "object", - "properties": { - "pointer": { - "type": "string", - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]." - }, - "parameter": { - "type": "string", - "description": "A string indicating which query parameter caused the error." - } - } + "links": { + "$ref": "#/components/schemas/links" }, "meta": { "$ref": "#/components/schemas/meta" } }, + "type": "object" + }, + "relationshipLinks": { + "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", + "properties": { + "self": { + "allOf": [ + { + "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", + "type": "array", + "items": { + "type": "object" + } + }, + { + "$ref": "#/components/schemas/link" + } + ] + }, + "related": { + "$ref": "#/components/schemas/link" + } + }, "type": "object", - "additionalProperties": false + "additionalProperties": true }, - "AclRoleJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ + "links": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/link" + } + }, + "link": { + "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", + "oneOf": [ { - "$ref": "#/components/schemas/resource" + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" }, { + "type": "object", "required": [ - "id", - "name" + "href" ], "properties": { - "id": { + "href": { + "description": "A string containing the link's URL.", "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "description": "Name of the ACL role defined.", - "type": "string" - }, - "description": { - "description": "A short description of the ACL role.", - "type": "string" + "format": "uri-reference" }, - "privileges": { - "type": "array", - "items": { - "type": "string" + "meta": { + "$ref": "#/components/schemas/meta" + } + } + } + ] + }, + "attributes": { + "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", + "type": "object", + "additionalProperties": true + }, + "relationships": { + "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", + "type": "object", + "anyOf": [ + { + "required": [ + "data" + ] + }, + { + "required": [ + "meta" + ] + }, + { + "required": [ + "links" + ] + }, + { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/relationshipLinks" + }, + "data": { + "description": "Member, whose value represents \"resource linkage\".", + "oneOf": [ + { + "$ref": "#/components/schemas/relationshipToOne" + }, + { + "$ref": "#/components/schemas/relationshipToMany" + } + ] + } + } + } + ], + "additionalProperties": false + }, + "relationshipToOne": { + "allOf": [ + { + "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." + }, + { + "$ref": "#/components/schemas/linkage" + } + ] + }, + "relationshipToMany": { + "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", + "type": "array", + "items": { + "$ref": "#/components/schemas/linkage" + }, + "uniqueItems": true + }, + "linkage": { + "description": "The \"type\" and \"id\" to non-empty members.", + "required": [ + "type", + "id" + ], + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object", + "additionalProperties": false + }, + "pagination": { + "properties": { + "first": { + "description": "The first page of data", + "type": "string", + "format": "uri-reference" + }, + "last": { + "description": "The last page of data", + "type": "string", + "format": "uri-reference" + }, + "prev": { + "description": "The previous page of data", + "type": "string", + "format": "uri-reference" + }, + "next": { + "description": "The next page of data", + "type": "string", + "format": "uri-reference" + } + }, + "type": "object" + }, + "jsonapi": { + "description": "An object describing the server's implementation", + "properties": { + "version": { + "type": "string" + }, + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object", + "additionalProperties": false + }, + "error": { + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for this particular occurrence of the problem." + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "status": { + "type": "string", + "description": "The HTTP status code applicable to this problem, expressed as a string value." + }, + "code": { + "type": "string", + "description": "An application-specific error code, expressed as a string value." + }, + "title": { + "type": "string", + "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization." + }, + "detail": { + "type": "string", + "description": "A human-readable explanation specific to this occurrence of the problem." + }, + "description": { + "type": "string", + "description": "A human-readable description of the problem." + }, + "source": { + "type": "object", + "properties": { + "pointer": { + "type": "string", + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]." + }, + "parameter": { + "type": "string", + "description": "A string indicating which query parameter caused the error." + } + } + }, + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object", + "additionalProperties": false + }, + "AclRoleJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the ACL role defined.", + "type": "string" + }, + "description": { + "description": "A short description of the ACL role.", + "type": "string" + }, + "privileges": { + "type": "array", + "items": { + "type": "string" } }, "deletedAt": { @@ -13540,6 +14576,35 @@ }, "extensions": { "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + }, "attendee": { "properties": { "links": { @@ -14382,6 +15447,35 @@ }, "extensions": { "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + }, "attendee": { "properties": { "links": { @@ -16572,6 +17666,9 @@ "description": "Technical name of document type.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -16582,9 +17679,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, @@ -16710,6 +17804,9 @@ "description": "Technical name of document type.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -16720,9 +17817,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, @@ -21925,6 +23019,9 @@ "systemDefault": { "type": "boolean" }, + "wasModifiedByUser": { + "type": "boolean" + }, "senderName": { "type": "string" }, @@ -22047,6 +23144,9 @@ "systemDefault": { "type": "boolean" }, + "wasModifiedByUser": { + "type": "boolean" + }, "senderName": { "type": "string" }, @@ -23416,6 +24516,37 @@ }, "type": "object" }, + "productOpenGraphImages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/productOpenGraphImages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "a067685a73a5308efd6117308e659025" + } + } + } + } + }, + "type": "object" + }, "orderLineItems": { "properties": { "links": { @@ -23925,6 +25056,12 @@ "$ref": "#/components/schemas/ProductConfiguratorSetting" } }, + "productOpenGraphImages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, "orderLineItems": { "type": "array", "items": { @@ -26531,6 +27668,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "stateMachineState": { @@ -27342,6 +28513,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "salesChannelTracking": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannelTracking" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0be2acfa806308827a1893fe389a7c8b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState", "description": "Current order state (e.g., open, in_progress, completed, cancelled)" @@ -32084,6 +33289,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "price": { "type": "array", "items": { @@ -32320,6 +33530,12 @@ "additionalProperties": false } }, + "ogTitle": { + "type": "string" + }, + "ogDescription": { + "type": "string" + }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -32662,6 +33878,36 @@ }, "type": "object" }, + "openGraphMedia": { + "description": "Open Graph image for social media sharing", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/openGraphMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bbda52d941a3452369a00f2880f4f358" + } + } + } + }, + "type": "object" + }, "featureSet": { "properties": { "links": { @@ -33446,6 +34692,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "openGraphMediaId": { + "description": "Media used as Open Graph image for social media sharing.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "price": { "type": "array", "items": { @@ -33682,6 +34933,12 @@ "additionalProperties": false } }, + "ogTitle": { + "type": "string" + }, + "ogDescription": { + "type": "string" + }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -33816,6 +35073,10 @@ "$ref": "#/components/schemas/ProductMedia", "description": "Main product image displayed in listings and detail pages" }, + "openGraphMedia": { + "$ref": "#/components/schemas/Media", + "description": "Open Graph image for social media sharing" + }, "featureSet": { "$ref": "#/components/schemas/ProductFeatureSet" }, @@ -34950,6 +36211,10 @@ "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, + "provider": { + "description": "Selected export provider identifier, for example open-ai or google.", + "type": "string" + }, "includeVariants": { "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" @@ -35215,6 +36480,10 @@ "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, + "provider": { + "description": "Selected export provider identifier, for example open-ai or google.", + "type": "string" + }, "includeVariants": { "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" @@ -37818,7 +39087,12 @@ "visibility": { "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", - "format": "int64" + "format": "int64", + "enum": [ + 10, + 20, + 30 + ] }, "createdAt": { "type": "string", @@ -37928,7 +39202,12 @@ "visibility": { "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listings and search`, `20` indicates `Hide in listings` and `30` indicates `Visible` everywhere.", "type": "integer", - "format": "int64" + "format": "int64", + "enum": [ + 10, + 20, + 30 + ] }, "createdAt": { "type": "string", @@ -41135,6 +42414,68 @@ }, "extensions": { "properties": { + "salesChannelTrackingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "example": "ac53756ec89dc96c6b7c724a748b1a90" + } + } + } + } + }, + "type": "object" + }, + "salesChannelTrackingCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "example": "cb8f22914de8c702eb773a34957f4124" + } + } + } + } + }, + "type": "object" + }, "themes": { "properties": { "links": { @@ -42503,6 +43844,68 @@ }, "extensions": { "properties": { + "salesChannelTrackingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_order" + }, + "id": { + "type": "string", + "example": "ac53756ec89dc96c6b7c724a748b1a90" + } + } + } + } + }, + "type": "object" + }, + "salesChannelTrackingCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/salesChannelTrackingCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_tracking_customer" + }, + "id": { + "type": "string", + "example": "cb8f22914de8c702eb773a34957f4124" + } + } + } + } + }, + "type": "object" + }, "themes": { "properties": { "links": { @@ -43412,6 +44815,298 @@ }, "type": "object" }, + "SalesChannelTrackingCustomerJsonApi": { + "description": "Added since version: 6.7.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customerId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-customer/ea2de1d5c97c761634c2ebf3a18ad1ae/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-customer/ea2de1d5c97c761634c2ebf3a18ad1ae/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelTrackingCustomer": { + "description": "Added since version: 6.7.9.0", + "required": [ + "id", + "customerId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "SalesChannelTrackingOrderJsonApi": { + "description": "Added since version: 6.7.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "order": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-order/a540f7ebb29a289fffaca652fef993f4/order" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-tracking-order/a540f7ebb29a289fffaca652fef993f4/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelTrackingOrder": { + "description": "Added since version: 6.7.9.0", + "required": [ + "id", + "orderId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, "SalesChannelTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ @@ -50592,87 +52287,75 @@ ], "additionalProperties": false }, - "Price": { + "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" + } + } + } + }, + "MeasurementUnits": { "type": "object", - "description": "Price object", + "description": "Configuration of the measurement system", "properties": { - "currencyId": { + "system": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." }, - "listPrice": { - "description": "", + "units": { "type": "object", + "description": "Units used in the measurement system.", "properties": { - "currencyId": { + "length": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net", - "linked" - ] - }, - "regulationPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { + "weight": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." } - }, - "required": [ - "gross", - "net", - "linked" - ] + } } - }, - "required": [ - "currencyId", - "gross", - "net", - "linked" - ] + } }, "OAuthScopes": { "description": "OAuth scopes that should be requested.", @@ -50798,32 +52481,6 @@ } ] }, - "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" - } - } - } - }, "MediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", @@ -50857,6 +52514,40 @@ } } }, + "businessEventsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the event" + }, + "class": { + "type": "string", + "description": "Class name of the event" + }, + "data": { + "type": "object", + "description": "Available data of event" + }, + "aware": { + "type": "array", + "description": "Flow builder will base on awareness to show actions", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "description": "Extensions data of event", + "items": { + "type": "string" + } + } + } + } + }, "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)", @@ -51563,83 +53254,87 @@ "field" ] }, - "MeasurementUnits": { + "Price": { "type": "object", - "description": "Configuration of the measurement system", + "description": "Price object", "properties": { - "system": { + "currencyId": { "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + "pattern": "^[0-9a-f]{32}$" }, - "units": { + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", "type": "object", - "description": "Units used in the measurement system.", "properties": { - "length": { + "currencyId": { "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." + "pattern": "^[0-9a-f]{32}$" }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" } - } - } - } - }, - "businessEventsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the event" - }, - "class": { - "type": "string", - "description": "Class name of the event" - }, - "data": { - "type": "object", - "description": "Available data of event" }, - "aware": { - "type": "array", - "description": "Flow builder will base on awareness to show actions", - "items": { - "type": "string" + "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" } }, - "extensions": { - "type": "array", - "description": "Extensions data of event", - "items": { - "type": "string" - } - } + "required": [ + "gross", + "net", + "linked" + ] } - } + }, + "required": [ + "currencyId", + "gross", + "net", + "linked" + ] }, "ConsentState": { "type": "object", @@ -51696,1009 +53391,740 @@ ], "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." } } }, - "CartDeliveryPosition": { + "Cart": { "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": { + "name": { + "description": "Name of the cart - for example `guest-cart`", "type": "string" }, - "lineItem": { - "$ref": "#/components/schemas/LineItem" + "token": { + "description": "Context token identifying the cart and the user session", + "type": "string" }, "price": { "$ref": "#/components/schemas/CalculatedPrice" - } - } - }, - "CartItems": { - "type": "object", - "properties": { - "items": { + }, + "lineItems": { + "description": "All items within the cart", "type": "array", "items": { "$ref": "#/components/schemas/LineItem" } - } - } - }, - "JoinAppointmentResponse": { - "type": "object", - "description": "Includes all data you will need to attend to a appointment.", - "properties": { - "mercureSubscriberTopics": { + }, + "errors": { "type": "array", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "items": { - "type": "string", - "description": "mercure topic" - }, - "description": "The topics to which the attendee/guide can subscribe for" - }, - "mercurePublisherTopic": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The topic to which the attendee/guide can send updates" - }, - "JWTMercureSubscriberToken": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The JWT mercure token to publish updates" - }, - "mercureHubPublicUrl": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The mercure hub url to connect for subscribing and updating" - }, - "JWTMercurePublisherToken": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The JWT mercure token to subscribe for updates" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The appointment id" - }, - "newContextToken": { - "type": "string", - "description": "The new context token will be used in the header (sw-context-token) for calling the other routes" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The created Id for the attendee" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the current sales channel" - }, - "salesChannelName": { - "type": "string", - "description": "The name of the current sales channel" - }, - "appointmentName": { - "type": "string", - "description": "The name of the appointment" - }, - "presentationGuideMode": { - "type": "string", - "enum": [ - "self", - "guided" - ], - "description": "The type of the appointment" - }, - "isPreview": { - "type": "boolean", - "description": "To see if it's a preview appointment" - }, - "attendeeName": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The name of the attendee" - }, - "videoUserId": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The video user id that attendee could use" - }, - "b2bFeatures": { - "type": "object", - "description": "The b2b features that available for the appointment", - "properties": { - "quoteManagement": { - "type": "boolean", - "description": "To know if the quote management is enabled for current customer" - } + "$ref": "#/components/schemas/CartError" } - } - }, - "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" - } - }, - "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" + "deliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDelivery" + } }, - "taxRules": { + "transactions": { + "description": "A list of all payment transactions associated with the current cart.", "type": "array", "items": { "type": "object", "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { + "paymentMethodId": { "type": "string" + }, + "amount": { + "$ref": "#/components/schemas/CalculatedPrice" } } } }, - "type": { - "type": "string" - } - }, - "required": [ - "apiAlias" - ] - }, - "AbstractDynamicPageOpenedPayload": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "description": "The type of the current dynamic page" - }, - "opened": { - "type": "boolean", - "default": true - } - } - }, - "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" + "modified": { + "type": "boolean" }, - "roomName": { + "customerComment": { "type": "string", - "description": "Name of the video room in daily" + "description": "A comment that can be added to the cart.", + "nullable": true }, - "userToken": { + "affiliateCode": { "type": "string", - "description": "Token for the end users to connect to the daily room" + "description": "An affiliate tracking code", + "nullable": true }, - "ownerToken": { + "campaignCode": { "type": "string", - "description": "Token for the room owner (guide) to connect to the daily room" + "description": "A campaign tracking code", + "nullable": true } - }, - "example": { - "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", - "userToken": "dummy user token", - "ownerToken": "dummy owner token", - "roomName": "rSq20mrgwsj4eIXo1u95", - "extensions": [] } }, - "CartPriceReference": { + "CartDeliveryInformation": { "type": "object", "properties": { - "purchaseUnit": { - "type": "number" - }, - "referenceUnit": { - "type": "number" - }, - "unitName": { - "type": "string" - }, - "price": { - "type": "number" - }, "apiAlias": { "type": "string", "enum": [ - "cart_price_reference" + "cart_delivery_information" ] }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] + "freeDelivery": { + "type": "boolean" }, - "regulationPrice": { + "deliveryTime": { "type": "object", "properties": { - "price": { - "type": "number" + "name": { + "type": "string" + }, + "min": { + "type": "integer" + }, + "max": { + "type": "integer" + }, + "unit": { + "type": "string" }, "apiAlias": { "type": "string", "enum": [ - "cart_regulation_price" + "cart_delivery_time" ] } - }, - "nullable": true + } }, - "hasRange": { - "type": "boolean" + "height": { + "type": "integer" }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true + "length": { + "type": "integer" + }, + "restockTime": { + "type": "integer" + }, + "stock": { + "type": "integer" + }, + "weight": { + "type": "integer" + }, + "width": { + "type": "integer" } }, "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitName" + "apiAlias" ] }, - "CartDelivery": { + "StateForGuides": { "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" - } - } - }, - "positions": { + "clients": { "type": "array", "items": { - "$ref": "#/components/schemas/CartDeliveryPosition" - } + "type": "string" + }, + "default": [] }, - "shippingCosts": { - "$ref": "#/components/schemas/CalculatedPrice" + "inactiveClients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "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" + "guides": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "discountValue": { - "type": "number", - "description": "Value of the discount (leave it 0 if you want to remove the discount)", - "maximum": 0 + "videoGuideToken": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] }, - "appliedItemIds": { + "quickViewState": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" }, - "description": "Ids of the items to which the discount should be applied" + "default": [] + }, + "extensions": { + "type": "array", + "default": [] } } }, - "AddCartDiscountRequestBody": { + "GetCartInsightsResponse": { "type": "object", - "required": [ - "discountType", - "discountValue" - ], + "description": "Returns aggregations for the current carts within the appointment.", "properties": { - "discountType": { - "$ref": "#/components/schemas/DiscountType" + "cartSum": { + "type": "number", + "description": "Sum of all products from all attenddees which were added to the cart during the appointment" }, - "discountValue": { + "productCount": { "type": "number", - "description": "Value of the discount (leave it 0 if you want to remove the discount)", - "maximum": 0 - } - } - }, - "BasePresentationSlideData": { - "properties": { - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" }, - "extensions": { - "type": "object", - "properties": { - "cmsPageRelation": { - "$ref": "#/components/schemas/PresentationCmsPage" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the shown currency" + }, + "currencySymbol": { + "type": "string", + "description": "The currency symbol from the shown currency" + }, + "topProducts": { + "type": "object", + "required": [ + "byQuantity", + "byRevenue" + ], + "properties": { + "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" + ] + } + }, + "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" + ] + } } } } + }, + "example": { + "extensions": [], + "cartSum": 6770.53, + "productCount": 3, + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$", + "topProducts": { + "byQuantity": [ + { + "productId": "01ae0dee60ea48fdafaf881b96361d59", + "value": 1 + }, + { + "productId": "fee3ca762be94bb49b692e359d529563", + "value": 1 + }, + { + "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", + "value": 1 + } + ], + "byRevenue": [ + { + "productId": "fee3ca762be94bb49b692e359d529563", + "value": 5333.03 + }, + { + "productId": "01ae0dee60ea48fdafaf881b96361d59", + "value": 1152.62 + }, + { + "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", + "value": 284.88 + } + ] + } } }, - "PresentationSlideData": { + "DynamicProductListingPageOpenedPayload": { + "required": [ + "page" + ], + "properties": { + "page": { + "type": "integer", + "description": "Current page position in the pagination" + } + } + }, + "WidgetProductListing": { "type": "object", + "description": "Includes all data you will need to attend to a appointment.", "properties": { - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" - }, "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" + }, + "page": { + "type": "integer", + "description": "The current page" + }, + "limit": { + "type": "integer", + "description": "The number of products per page" + } + } + }, + "CartListPrice": { + "type": "object", + "description": "", + "properties": { + "discount": { + "type": "number" + }, + "percentage": { + "type": "number" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_list_price" + ] + } + }, + "required": [ + "apiAlias" + ] + }, + "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" + } + } + }, + "CartPriceReference": { + "type": "object", + "properties": { + "purchaseUnit": { + "type": "number" + }, + "referenceUnit": { + "type": "number" + }, + "unitName": { + "type": "string" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_reference" + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { "type": "object", "properties": { - "cmsPageRelation": { - "$ref": "#/components/schemas/PresentationCmsPage" + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] } - } - }, - "product": { - "$ref": "#/components/schemas/Product" + }, + "nullable": true }, - "category": { - "$ref": "#/components/schemas/Category" + "hasRange": { + "type": "boolean" }, - "configurator": { + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true + } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] + }, + "CartItems": { + "type": "object", + "properties": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/LineItem" } } - }, - "example": { - "extensions": { - "cmsPageRelation": { - "translated": { - "title": null - }, - "createdAt": "2023-08-09T11:00:13.160+00:00", - "updatedAt": null, - "presentationId": "506cce706e914c1e8b083f05670d85c4", - "cmsPageId": "33e88c7994fa4cf79a1265e5105b93b2", - "title": null, - "productId": null, - "productStreamId": null, - "position": 2, - "isInstantListing": false, - "cmsPage": { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": { - "name": "Default Digital Sales Rooms product listing page", - "customFields": [] - }, - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "name": "Default Digital Sales Rooms product listing page", - "type": "presentation_product_list", - "entity": null, - "sections": [ + } + }, + "AbstractDynamicPageOpenedPayload": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of the current dynamic page" + }, + "opened": { + "type": "boolean", + "default": true + } + } + }, + "PresentationCmsPage": { + "allOf": [ + { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + }, + { + "type": "object", + "properties": { + "pickedProductIds": { + "anyOf": [ { - "translated": [], - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "default", - "blocks": [ - { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": [], - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "product-listing", - "slots": [ - { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": { - "config": { - "filters": { - "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", - "source": "static" - }, - "boxLayout": { - "value": "standard", - "source": "static" - }, - "showSorting": { - "value": true, - "source": "static" - }, - "defaultSorting": { - "value": "", - "source": "static" - }, - "useCustomSorting": { - "value": false, - "source": "static" - }, - "availableSortings": { - "value": [], - "source": "static" - }, - "propertyWhitelist": { - "value": [], - "source": "static" - } - }, - "customFields": [] - }, - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "product-listing", - "slot": "content", - "block": null, - "blockId": "96ea8b9676a5461c9149d205d792ecf2", - "config": { - "filters": { - "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", - "source": "static" - }, - "boxLayout": { - "value": "standard", - "source": "static" - }, - "showSorting": { - "value": true, - "source": "static" - }, - "defaultSorting": { - "value": "", - "source": "static" - }, - "useCustomSorting": { - "value": false, - "source": "static" - }, - "availableSortings": { - "value": [], - "source": "static" - }, - "propertyWhitelist": { - "value": [], - "source": "static" - } - }, - "fieldConfig": null, - "translations": null, - "data": null, - "locked": false, - "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "customFields": null, - "apiAlias": "cms_slot" - } - ], - "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", - "position": 0, - "name": null, - "sectionPosition": "main", - "marginTop": "20px", - "marginBottom": "20px", - "marginLeft": "20px", - "marginRight": "20px", - "backgroundColor": null, - "backgroundMediaId": null, - "backgroundMedia": null, - "backgroundMediaMode": "cover", - "cssClass": null, - "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "visibility": null, - "customFields": null, - "apiAlias": "cms_block" - } - ], - "pageId": "33e88c7994fa4cf79a1265e5105b93b2", - "page": null, - "position": 0, - "sizingMode": "boxed", - "mobileBehavior": "wrap", - "backgroundColor": null, - "backgroundMediaId": null, - "backgroundMedia": null, - "backgroundMediaMode": "cover", - "cssClass": null, - "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "visibility": null, - "customFields": null, - "apiAlias": "cms_section" + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Product id" + } + }, + { + "type": "null" } ], - "translations": null, - "cssClass": null, - "config": null, - "previewMediaId": null, - "previewMedia": null, - "landingPages": null, - "id": "33e88c7994fa4cf79a1265e5105b93b2", - "customFields": null, - "apiAlias": "cms_page" - }, - "pickedProductIds": null, - "dsrPresentationVersionId": "213769ba28dd4ee788bdb49dc9ce53d2", - "id": "4ee08e142ed046eb99681594f67599f1", - "customFields": null, - "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "apiAlias": "dsr_presentation_cms_page" + "description": "The product id is assigned to presentation if it's product listing or instant listing" + } } - }, - "cmsPage": { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": { - "name": "Default Digital Sales Rooms product listing page", - "customFields": [] - }, - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "name": "Default Digital Sales Rooms product listing page", - "type": "presentation_product_list", - "entity": null, - "sections": [ + } + ] + }, + "DynamicPageOpenedPayload": { + "allOf": [ + { + "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" + } + ] + }, + "StateForAll": { + "type": "object", + "properties": { + "currentGuideProductId": { + "anyOf": [ { - "translated": [], - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "default", - "blocks": [ - { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": [], - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "product-listing", - "slots": [ - { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": { - "config": { - "filters": { - "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", - "source": "static" - }, - "boxLayout": { - "value": "standard", - "source": "static" - }, - "showSorting": { - "value": true, - "source": "static" - }, - "defaultSorting": { - "value": "", - "source": "static" - }, - "useCustomSorting": { - "value": false, - "source": "static" - }, - "availableSortings": { - "value": [], - "source": "static" - }, - "propertyWhitelist": { - "value": [], - "source": "static" - } - }, - "customFields": [] - }, - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "product-listing", - "slot": "content", - "block": null, - "blockId": "96ea8b9676a5461c9149d205d792ecf2", - "config": { - "filters": { - "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", - "source": "static" - }, - "boxLayout": { - "value": "standard", - "source": "static" - }, - "showSorting": { - "value": true, - "source": "static" - }, - "defaultSorting": { - "value": "", - "source": "static" - }, - "useCustomSorting": { - "value": false, - "source": "static" - }, - "availableSortings": { - "value": [], - "source": "static" - }, - "propertyWhitelist": { - "value": [], - "source": "static" - } - }, - "fieldConfig": null, - "translations": null, - "data": { - "listing": { - "elements": [ - { - "versionId": null, - "translated": [], - "createdAt": null, - "updatedAt": null, - "parentId": null, - "childCount": null, - "taxId": null, - "manufacturerId": null, - "unitId": null, - "active": null, - "displayGroup": null, - "manufacturerNumber": null, - "ean": null, - "sales": null, - "productNumber": null, - "stock": null, - "availableStock": null, - "available": null, - "deliveryTimeId": null, - "deliveryTime": null, - "restockTime": null, - "isCloseout": null, - "purchaseSteps": null, - "maxPurchase": null, - "minPurchase": null, - "purchaseUnit": null, - "referenceUnit": null, - "shippingFree": null, - "markAsTopseller": null, - "weight": null, - "width": null, - "height": null, - "length": null, - "releaseDate": null, - "categoryTree": null, - "streamIds": null, - "optionIds": null, - "propertyIds": null, - "name": null, - "keywords": null, - "description": null, - "metaDescription": null, - "metaTitle": null, - "packUnit": null, - "packUnitPlural": null, - "tax": null, - "manufacturer": null, - "unit": null, - "cover": null, - "parent": null, - "children": null, - "media": null, - "cmsPageId": null, - "cmsPage": null, - "translations": null, - "categories": null, - "properties": null, - "options": null, - "configuratorSettings": null, - "categoriesRo": null, - "coverId": null, - "categoryIds": null, - "productReviews": null, - "ratingAverage": null, - "mainCategories": null, - "seoUrls": null, - "crossSellings": null, - "canonicalProductId": null, - "canonicalProduct": null, - "streams": null, - "downloads": null, - "states": [], - "id": "a32702bb0b1443e3881c3b9a38c09169", - "customFields": null, - "apiAlias": "product" - } - ], - "aggregations": [], - "page": 1, - "limit": null, - "entity": "product", - "total": 0, - "states": [], - "apiAlias": "dal_entity_search_result" - }, - "apiAlias": "cms_product_listing" - }, - "locked": false, - "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "customFields": null, - "apiAlias": "cms_slot" - } - ], - "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", - "position": 0, - "name": null, - "sectionPosition": "main", - "marginTop": "20px", - "marginBottom": "20px", - "marginLeft": "20px", - "marginRight": "20px", - "backgroundColor": null, - "backgroundMediaId": null, - "backgroundMedia": null, - "backgroundMediaMode": "cover", - "cssClass": null, - "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "visibility": null, - "customFields": null, - "apiAlias": "cms_block" - } - ], - "pageId": "33e88c7994fa4cf79a1265e5105b93b2", - "page": null, - "position": 0, - "sizingMode": "boxed", - "mobileBehavior": "wrap", - "backgroundColor": null, - "backgroundMediaId": null, - "backgroundMedia": null, - "backgroundMediaMode": "cover", - "cssClass": null, - "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "visibility": null, - "customFields": null, - "apiAlias": "cms_section" + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "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" ], - "translations": null, - "cssClass": null, - "config": null, - "previewMediaId": null, - "previewMedia": null, - "landingPages": null, - "id": "33e88c7994fa4cf79a1265e5105b93b2", - "customFields": null, - "apiAlias": "cms_page" + "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" - } - }, - "StateForGuides": { - "type": "object", - "properties": { - "clients": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "attendeeRestrictionType": { + "anyOf": [ + { + "type": "string", + "enum": [ + "open", + "customer", + "rules" + ] + }, + { + "type": "null" + } + ] }, - "inactiveClients": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "productDetailDefaultPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] }, - "guides": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "quickviewPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] }, - "videoGuideToken": { + "productListingDefaultPageId": { "anyOf": [ { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, { "type": "null" } ] }, - "quickViewState": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "broadcastMode": { + "type": "boolean", + "default": false + }, + "viewMode": { + "type": "string", + "enum": [ + "onlyYou", + "presentation", + "videoGrid" + ], + "default": "presentation" + }, + "allowScreenSharing": { + "type": "boolean", + "default": false }, "extensions": { "type": "array", @@ -52706,1192 +54132,1475 @@ } } }, - "GetListBodyRequest": { + "CartError": { "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "limit": { - "type": "integer", - "description": "Max amount of resources to be returned in a page" - }, - "page": { - "type": "integer", - "description": "The page to be returned" + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "level": { + "type": "number", + "enum": [ + 0, + 10, + 20 + ], + "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" + }, + "message": { + "type": "string" + }, + "messageKey": { + "type": "string" + } + } } } }, - "WidgetProductListing": { + "GetAttendeeInsightsResponse": { "type": "object", - "description": "Includes all data you will need to attend to a appointment.", + "description": "Returns aggregations for the current attendees within the 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" - } - } - } - } - } - } - ] + "attendees": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/AttendeeInsights" } }, - "total": { - "type": "integer", - "description": "The total number of products" - }, - "page": { - "type": "integer", - "description": "The current page" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "limit": { - "type": "integer", - "description": "The number of products per page" + "currencySymbol": { + "type": "string" } + }, + "example": { + "extensions": [], + "attendees": { + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } + }, + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$" } }, - "LineItemType": { - "type": "string", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "discount", - "container", - "quantity", - "dsr-line-item-discount", - "dsr-cart-discount" - ] - }, - "DiscountLineItemPayload": { + "GuidePresentationStateResponse": { "type": "object", "properties": { - "discountType": { - "type": "string", - "enum": [ - "percentage", - "absolute" - ] + "stateForAll": { + "$ref": "#/components/schemas/StateForAll" }, - "discountValue": { - "type": "number", - "format": "float", - "maximum": 0 + "stateForClients": { + "$ref": "#/components/schemas/StateForGuides" + } + }, + "example": { + "extensions": [], + "stateForAll": { + "currentGuideProductId": null, + "lastActiveGuideSection": null, + "currentPageId": null, + "currentSectionId": null, + "currentSlideAlias": 0, + "currentDynamicPage": null, + "started": false, + "running": false, + "ended": false, + "startedAt": null, + "endedAt": null, + "accessibleFrom": { + "date": "2023-08-04 00:00:00.000000", + "timezone_type": 3, + "timezone": "UTC" + }, + "accessibleTo": { + "date": "2023-08-05 00:00:00.000000", + "timezone_type": 3, + "timezone": "UTC" + }, + "appointmentMode": "guided", + "videoAudioSettings": "both", + "videoRoomUrl": "", + "attendeeRestrictionType": "open", + "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", + "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", + "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", + "broadcastMode": false, + "extensions": [] }, - "discountPrice": { - "type": "number", - "format": "float", - "maximum": 0 + "stateForGuides": { + "clients": [], + "inactiveClients": { + "2b4066cd37a341088e32a81e04a56817": { + "attendeeId": "2b4066cd37a341088e32a81e04a56817", + "attendeeName": "Attendee 1", + "videoUserId": null, + "hasJoined": false + }, + "302108ad602b4ac687f5247aae5d0297": { + "attendeeId": "302108ad602b4ac687f5247aae5d0297", + "attendeeName": null, + "videoUserId": null, + "hasJoined": true + }, + "5a3b4e84acab47119b8a6bceb79e732e": { + "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", + "attendeeName": "Test attende name", + "videoUserId": null, + "hasJoined": true + }, + "b6358241e4ad4a4e99d0f729d21d63be": { + "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", + "attendeeName": null, + "videoUserId": null, + "hasJoined": true + }, + "f1bb9374308d4e088c29d10a2fc8cc07": { + "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", + "attendeeName": null, + "videoUserId": null, + "hasJoined": false + } + }, + "guides": { + "1850bbdc12dc44aba95bc78b16c3643c": { + "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", + "attendeeName": " admin", + "videoUserId": null, + "hasJoined": true + } + }, + "videoGuideToken": null, + "quickViewState": [], + "extensions": [] } } }, - "LineItem": { + "CartPriceQuantity": { "type": "object", "properties": { - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - }, - "cover": { - "$ref": "#/components/schemas/ProductMedia" - }, - "dataContextHash": { - "type": "string" - }, - "dataTimestamp": { - "type": "string" - }, - "deliveryInformation": { - "$ref": "#/components/schemas/CartDeliveryInformation" - }, - "description": { - "type": "string" + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_quantity" + ] }, - "good": { + "isCalculated": { "type": "boolean" }, - "id": { - "type": "string" + "listPrice": { + "$ref": "#/components/schemas/CartListPrice" }, - "label": { - "type": "string" + "price": { + "type": "number" }, - "modified": { - "type": "boolean" + "quantity": { + "type": "number" }, - "modifiedByApp": { - "type": "boolean" + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/ProductJsonApi" - }, - { - "type": "object", - "properties": { - "discountType": { - "type": "string", - "enum": [ - "percentage", - "absolute" - ] - }, - "discountValue": { - "type": "number", - "format": "float", - "maximum": 0 - }, - "discountPrice": { - "type": "number", - "format": "float", - "maximum": 0 - } + "taxRules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" } } - ] + } }, - "extensions": { + "type": { + "type": "string" + } + }, + "required": [ + "apiAlias" + ] + }, + "CartDelivery": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { "type": "object", "properties": { - "meta": { - "type": "object", - "properties": { - "attendees": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - } - } - } - } - } + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" } } }, - "price": { + "location": { "type": "object", "properties": { "apiAlias": { "type": "string", "enum": [ - "calculated_price" - ] - }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" - } - }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] - } - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] - }, - "quantity": { - "type": "number" - }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } + "cart_delivery_shipping_location" ] }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true - }, - "totalPrice": { - "type": "number" + "country": { + "$ref": "#/components/schemas/Country" }, - "unitPrice": { - "type": "number" + "address": { + "$ref": "#/components/schemas/CustomerAddress" }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } + "state": { + "$ref": "#/components/schemas/CountryState" } - }, - "required": [ - "apiAlias", - "totalPrice", - "quantity", - "unitPrice" - ] + } }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDeliveryPosition" + } }, - "quantity": { - "type": "number" + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" }, - "quantityInformation": { + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + }, + "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": [] + } + }, + "CartDeliveryPosition": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { "type": "object", "properties": { - "maxPurchase": { - "type": "number" - }, - "minPurchase": { - "type": "number" + "earliest": { + "type": "string", + "format": "date-time" }, - "purchaseSteps": { - "type": "number" + "latest": { + "type": "string", + "format": "date-time" } } }, - "referencedId": { + "identifier": { "type": "string" }, - "removable": { - "type": "boolean" + "lineItem": { + "$ref": "#/components/schemas/LineItem" }, - "stackable": { - "type": "boolean" + "price": { + "$ref": "#/components/schemas/CalculatedPrice" + } + } + }, + "CalculatedPrice": { + "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", + "properties": { + "unitPrice": { + "type": "number" }, - "states": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "is-physical", - "is-download" - ] - } + "quantity": { + "type": "number" }, - "type": { - "$ref": "#/components/schemas/LineItemType" + "rawTotal": { + "type": "number" }, - "uniqueIdentifier": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - }, - "PresentationCmsPage": { - "allOf": [ - { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "totalPrice": { + "type": "number" }, - { + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "positionPrice": { + "type": "number" + }, + "netPrice": { + "type": "number" + }, + "regulationPrice": { "type": "object", "properties": { - "pickedProductIds": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Product id" - } - }, - { - "type": "null" - } - ], - "description": "The product id is assigned to presentation if it's product listing or instant listing" + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + }, + "nullable": true + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true + }, + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } } } } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "referencePrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitPrice", + "positionPrice", + "netPrice", + "taxRules" ] }, - "AttendeeInsights": { - "type": "object", - "description": "Attendee Insights", + "BasePresentationSlideData": { "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" + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" }, - "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 + "extensions": { + "type": "object", + "properties": { + "cmsPageRelation": { + "$ref": "#/components/schemas/PresentationCmsPage" + } + } } } }, - "GetCartInsightsResponse": { + "PresentationSlideData": { "type": "object", - "description": "Returns aggregations for the current carts within the appointment.", "properties": { - "cartSum": { - "type": "number", - "description": "Sum of all products from all attenddees which were added to the cart during the appointment" - }, - "productCount": { - "type": "number", - "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the shown currency" - }, - "currencySymbol": { - "type": "string", - "description": "The currency symbol from the shown currency" + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" }, - "topProducts": { + "extensions": { "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" - ] - } - }, - "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" - ] - } + "cmsPageRelation": { + "$ref": "#/components/schemas/PresentationCmsPage" } } + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "category": { + "$ref": "#/components/schemas/Category" + }, + "configurator": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } } }, "example": { - "extensions": [], - "cartSum": 6770.53, - "productCount": 3, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$", - "topProducts": { - "byQuantity": [ - { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1 - }, - { - "productId": "fee3ca762be94bb49b692e359d529563", - "value": 1 - }, - { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 1 - } - ], - "byRevenue": [ - { - "productId": "fee3ca762be94bb49b692e359d529563", - "value": 5333.03 + "extensions": { + "cmsPageRelation": { + "translated": { + "title": null }, - { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1152.62 + "createdAt": "2023-08-09T11:00:13.160+00:00", + "updatedAt": null, + "presentationId": "506cce706e914c1e8b083f05670d85c4", + "cmsPageId": "33e88c7994fa4cf79a1265e5105b93b2", + "title": null, + "productId": null, + "productStreamId": null, + "position": 2, + "isInstantListing": false, + "cmsPage": { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "name": "Default Digital Sales Rooms product listing page", + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "name": "Default Digital Sales Rooms product listing page", + "type": "presentation_product_list", + "entity": null, + "sections": [ + { + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "default", + "blocks": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slots": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slot": "content", + "block": null, + "blockId": "96ea8b9676a5461c9149d205d792ecf2", + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "fieldConfig": null, + "translations": null, + "data": null, + "locked": false, + "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "customFields": null, + "apiAlias": "cms_slot" + } + ], + "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", + "position": 0, + "name": null, + "sectionPosition": "main", + "marginTop": "20px", + "marginBottom": "20px", + "marginLeft": "20px", + "marginRight": "20px", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_block" + } + ], + "pageId": "33e88c7994fa4cf79a1265e5105b93b2", + "page": null, + "position": 0, + "sizingMode": "boxed", + "mobileBehavior": "wrap", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_section" + } + ], + "translations": null, + "cssClass": null, + "config": null, + "previewMediaId": null, + "previewMedia": null, + "landingPages": null, + "id": "33e88c7994fa4cf79a1265e5105b93b2", + "customFields": null, + "apiAlias": "cms_page" }, + "pickedProductIds": null, + "dsrPresentationVersionId": "213769ba28dd4ee788bdb49dc9ce53d2", + "id": "4ee08e142ed046eb99681594f67599f1", + "customFields": null, + "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "apiAlias": "dsr_presentation_cms_page" + } + }, + "cmsPage": { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "name": "Default Digital Sales Rooms product listing page", + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "name": "Default Digital Sales Rooms product listing page", + "type": "presentation_product_list", + "entity": null, + "sections": [ { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 284.88 + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "default", + "blocks": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slots": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slot": "content", + "block": null, + "blockId": "96ea8b9676a5461c9149d205d792ecf2", + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "fieldConfig": null, + "translations": null, + "data": { + "listing": { + "elements": [ + { + "versionId": null, + "translated": [], + "createdAt": null, + "updatedAt": null, + "parentId": null, + "childCount": null, + "taxId": null, + "manufacturerId": null, + "unitId": null, + "active": null, + "displayGroup": null, + "manufacturerNumber": null, + "ean": null, + "sales": null, + "productNumber": null, + "stock": null, + "availableStock": null, + "available": null, + "deliveryTimeId": null, + "deliveryTime": null, + "restockTime": null, + "isCloseout": null, + "purchaseSteps": null, + "maxPurchase": null, + "minPurchase": null, + "purchaseUnit": null, + "referenceUnit": null, + "shippingFree": null, + "markAsTopseller": null, + "weight": null, + "width": null, + "height": null, + "length": null, + "releaseDate": null, + "categoryTree": null, + "streamIds": null, + "optionIds": null, + "propertyIds": null, + "name": null, + "keywords": null, + "description": null, + "metaDescription": null, + "metaTitle": null, + "packUnit": null, + "packUnitPlural": null, + "tax": null, + "manufacturer": null, + "unit": null, + "cover": null, + "parent": null, + "children": null, + "media": null, + "cmsPageId": null, + "cmsPage": null, + "translations": null, + "categories": null, + "properties": null, + "options": null, + "configuratorSettings": null, + "categoriesRo": null, + "coverId": null, + "categoryIds": null, + "productReviews": null, + "ratingAverage": null, + "mainCategories": null, + "seoUrls": null, + "crossSellings": null, + "canonicalProductId": null, + "canonicalProduct": null, + "streams": null, + "downloads": null, + "states": [], + "id": "a32702bb0b1443e3881c3b9a38c09169", + "customFields": null, + "apiAlias": "product" + } + ], + "aggregations": [], + "page": 1, + "limit": null, + "entity": "product", + "total": 0, + "states": [], + "apiAlias": "dal_entity_search_result" + }, + "apiAlias": "cms_product_listing" + }, + "locked": false, + "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "customFields": null, + "apiAlias": "cms_slot" + } + ], + "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", + "position": 0, + "name": null, + "sectionPosition": "main", + "marginTop": "20px", + "marginBottom": "20px", + "marginLeft": "20px", + "marginRight": "20px", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_block" + } + ], + "pageId": "33e88c7994fa4cf79a1265e5105b93b2", + "page": null, + "position": 0, + "sizingMode": "boxed", + "mobileBehavior": "wrap", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_section" } - ] - } - } - }, - "GuidePresentationStateResponse": { - "type": "object", - "properties": { - "stateForAll": { - "$ref": "#/components/schemas/StateForAll" + ], + "translations": null, + "cssClass": null, + "config": null, + "previewMediaId": null, + "previewMedia": null, + "landingPages": null, + "id": "33e88c7994fa4cf79a1265e5105b93b2", + "customFields": null, + "apiAlias": "cms_page" }, - "stateForClients": { - "$ref": "#/components/schemas/StateForGuides" - } - }, - "example": { - "extensions": [], - "stateForAll": { - "currentGuideProductId": null, - "lastActiveGuideSection": null, - "currentPageId": null, - "currentSectionId": null, - "currentSlideAlias": 0, - "currentDynamicPage": null, - "started": false, - "running": false, - "ended": false, - "startedAt": null, - "endedAt": null, - "accessibleFrom": { - "date": "2023-08-04 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "accessibleTo": { - "date": "2023-08-05 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" + "category": { + "versionId": null, + "translated": { + "breadcrumb": [] }, - "appointmentMode": "guided", - "videoAudioSettings": "both", - "videoRoomUrl": "", - "attendeeRestrictionType": "open", - "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", - "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", - "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", - "broadcastMode": false, - "extensions": [] + "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" }, - "stateForGuides": { - "clients": [], - "inactiveClients": { - "2b4066cd37a341088e32a81e04a56817": { - "attendeeId": "2b4066cd37a341088e32a81e04a56817", - "attendeeName": "Attendee 1", - "videoUserId": null, - "hasJoined": false - }, - "302108ad602b4ac687f5247aae5d0297": { - "attendeeId": "302108ad602b4ac687f5247aae5d0297", - "attendeeName": null, - "videoUserId": null, - "hasJoined": true - }, - "5a3b4e84acab47119b8a6bceb79e732e": { - "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", - "attendeeName": "Test attende name", - "videoUserId": null, - "hasJoined": true - }, - "b6358241e4ad4a4e99d0f729d21d63be": { - "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", - "attendeeName": null, - "videoUserId": null, - "hasJoined": true - }, - "f1bb9374308d4e088c29d10a2fc8cc07": { - "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", - "attendeeName": null, - "videoUserId": null, - "hasJoined": false - } - }, - "guides": { - "1850bbdc12dc44aba95bc78b16c3643c": { - "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", - "attendeeName": " admin", - "videoUserId": null, - "hasJoined": true - } - }, - "videoGuideToken": null, - "quickViewState": [], - "extensions": [] - } + "apiAlias": "pwa_page_result" } }, - "CartDeliveryInformation": { + "LineItemType": { + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "discount", + "container", + "quantity", + "dsr-line-item-discount", + "dsr-cart-discount" + ] + }, + "DiscountLineItemPayload": { "type": "object", "properties": { - "apiAlias": { + "discountType": { "type": "string", "enum": [ - "cart_delivery_information" + "percentage", + "absolute" ] }, - "freeDelivery": { - "type": "boolean" - }, - "deliveryTime": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "min": { - "type": "integer" - }, - "max": { - "type": "integer" - }, - "unit": { - "type": "string" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_time" - ] - } - } - }, - "height": { - "type": "integer" - }, - "length": { - "type": "integer" - }, - "restockTime": { - "type": "integer" - }, - "stock": { - "type": "integer" - }, - "weight": { - "type": "integer" + "discountValue": { + "type": "number", + "format": "float", + "maximum": 0 }, - "width": { - "type": "integer" - } - }, - "required": [ - "apiAlias" - ] - }, - "DynamicPageOpenedPayload": { - "allOf": [ - { - "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" - } - ] - }, - "DynamicProductListingPageOpenedPayload": { - "required": [ - "page" - ], - "properties": { - "page": { - "type": "integer", - "description": "Current page position in the pagination" + "discountPrice": { + "type": "number", + "format": "float", + "maximum": 0 } } }, - "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" - } - ] + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "currentPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] + "cover": { + "$ref": "#/components/schemas/ProductMedia" }, - "currentSectionId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] + "dataContextHash": { + "type": "string" }, - "currentSlideAlias": { - "type": "integer", - "default": 0 + "dataTimestamp": { + "type": "string" }, - "currentSlideData": { - "anyOf": [ - { - "$ref": "#/components/schemas/DynamicProductListingPageOpenedPayload" - }, - { - "type": "null" - } - ] + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" }, - "currentDynamicPage": { - "$ref": "#/components/schemas/DynamicPageOpenedPayload" + "description": { + "type": "string" }, - "started": { - "type": "boolean", - "default": false + "good": { + "type": "boolean" }, - "running": { - "type": "boolean", - "default": false + "id": { + "type": "string" }, - "ended": { - "type": "boolean", - "default": false + "label": { + "type": "string" }, - "startedAt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] + "modified": { + "type": "boolean" }, - "endedAt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] + "modifiedByApp": { + "type": "boolean" }, - "accessibleFrom": { - "anyOf": [ + "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 + } + } } ] }, - "accessibleTo": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" + "extensions": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "attendees": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + } + } + } + } + } } - ] - }, - "appointmentMode": { - "type": "string", - "enum": [ - "guided", - "self" - ] - }, - "videoAudioSettings": { - "type": "string", - "enum": [ - "both", - "none", - "audio-only" - ], - "default": "none" - }, - "videoRoomUrl": { - "type": "string", - "default": "" + } }, - "attendeeRestrictionType": { - "anyOf": [ - { + "price": { + "type": "object", + "properties": { + "apiAlias": { "type": "string", "enum": [ - "open", - "customer", - "rules" + "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" + } ] }, - { - "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" ] }, - "productDetailDefaultPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] + "priceDefinition": { + "$ref": "#/components/schemas/CartPriceQuantity" }, - "quickviewPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] + "quantity": { + "type": "number" }, - "productListingDefaultPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": [] - } - } - }, - "CartListPrice": { - "type": "object", - "description": "", - "properties": { - "discount": { - "type": "number" - }, - "percentage": { - "type": "number" + "items": { + "type": "string", + "enum": [ + "is-physical", + "is-download" + ] + } }, - "price": { - "type": "number" + "type": { + "$ref": "#/components/schemas/LineItemType" }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_list_price" - ] + "uniqueIdentifier": { + "type": "string" } }, "required": [ - "apiAlias" + "id", + "type" ] }, - "GetAttendeeInsightsResponse": { + "AttendeeInsights": { "type": "object", - "description": "Returns aggregations for the current attendees within the appointment.", + "description": "Attendee Insights", "properties": { - "attendees": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/AttendeeInsights" - } - }, - "currencyId": { + "id": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$", + "description": "Id of the attendee" }, - "currencySymbol": { - "type": "string" + "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": { - "extensions": [], - "attendees": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } - }, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$" + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } } }, - "CartError": { + "DiscountType": { + "type": "string", + "description": "Type of the discount", + "enum": [ + "percentage", + "absolute" + ] + }, + "AddTempDiscountRequestBody": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "required": [ + "discountType", + "discountValue", + "appliedItemIds" + ], "properties": { - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "level": { - "type": "number", - "enum": [ - 0, - 10, - 20 - ], - "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" - }, - "message": { - "type": "string" - }, - "messageKey": { - "type": "string" - } - } + "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 + }, + "appliedItemIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the items to which the discount should be applied" } } }, - "Cart": { + "AddCartDiscountRequestBody": { "type": "object", + "required": [ + "discountType", + "discountValue" + ], "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" + "discountType": { + "$ref": "#/components/schemas/DiscountType" }, - "lineItems": { - "description": "All items within the cart", + "discountValue": { + "type": "number", + "description": "Value of the discount (leave it 0 if you want to remove the discount)", + "maximum": 0 + } + } + }, + "JoinAppointmentResponse": { + "type": "object", + "description": "Includes all data you will need to attend to a appointment.", + "properties": { + "mercureSubscriberTopics": { "type": "array", "items": { - "$ref": "#/components/schemas/LineItem" - } + "type": "string", + "description": "mercure topic" + }, + "description": "The topics to which the attendee/guide can subscribe for" }, - "errors": { - "type": "array", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "items": { - "$ref": "#/components/schemas/CartError" - } + "mercurePublisherTopic": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The topic to which the attendee/guide can send updates" }, - "deliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDelivery" - } + "JWTMercureSubscriberToken": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The JWT mercure token to publish updates" }, - "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" - } + "mercureHubPublicUrl": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" } - } + ], + "description": "The mercure hub url to connect for subscribing and updating" }, - "modified": { - "type": "boolean" + "JWTMercurePublisherToken": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The JWT mercure token to subscribe for updates" }, - "customerComment": { + "id": { "type": "string", - "description": "A comment that can be added to the cart.", - "nullable": true + "pattern": "^[0-9a-f]{32}$", + "description": "The appointment id" }, - "affiliateCode": { + "newContextToken": { "type": "string", - "description": "An affiliate tracking code", - "nullable": true + "description": "The new context token will be used in the header (sw-context-token) for calling the other routes" }, - "campaignCode": { + "attendeeId": { "type": "string", - "description": "A campaign tracking code", - "nullable": true - } - } - }, - "CalculatedPrice": { - "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", - "properties": { - "unitPrice": { - "type": "number" + "pattern": "^[0-9a-f]{32}$", + "description": "The created Id for the attendee" }, - "quantity": { - "type": "number" + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the current sales channel" }, - "rawTotal": { - "type": "number" + "salesChannelName": { + "type": "string", + "description": "The name of the current sales channel" }, - "totalPrice": { - "type": "number" + "appointmentName": { + "type": "string", + "description": "The name of the appointment" }, - "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" - ] - } + "presentationGuideMode": { + "type": "string", + "enum": [ + "self", + "guided" + ], + "description": "The type of the appointment" }, - "referencePrice": { + "isPreview": { + "type": "boolean", + "description": "To see if it's a preview appointment" + }, + "attendeeName": { "oneOf": [ { - "$ref": "#/components/schemas/CartPriceReference" + "type": "string" }, { "type": "null" } - ] + ], + "description": "The name of the attendee" }, - "listPrice": { + "videoUserId": { "oneOf": [ { - "$ref": "#/components/schemas/CartListPrice" + "type": "string" }, { "type": "null" } - ] - }, - "positionPrice": { - "type": "number" - }, - "netPrice": { - "type": "number" + ], + "description": "The video user id that attendee could use" }, - "regulationPrice": { + "b2bFeatures": { "type": "object", + "description": "The b2b features that available for the appointment", "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true - }, - "hasRange": { - "type": "boolean" - }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true - }, - "apiAlias": { - "type": "string", - "enum": [ - "calculated_price" - ] - }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } + "quoteManagement": { + "type": "boolean", + "description": "To know if the quote management is enabled for current customer" } } } }, - "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "referencePrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitPrice", - "positionPrice", - "netPrice", - "taxRules" - ] + "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" + } } }, "responses": { @@ -54726,6 +56435,14 @@ "name": "Sales Channel Domain", "description": "The endpoint for operations on Sales Channel Domain" }, + { + "name": "Sales Channel Tracking Customer", + "description": "The endpoint for operations on Sales Channel Tracking Customer" + }, + { + "name": "Sales Channel Tracking Order", + "description": "The endpoint for operations on Sales Channel Tracking Order" + }, { "name": "Sales Channel Type", "description": "The endpoint for operations on Sales Channel Type" diff --git a/SwagDigitalSalesRooms-adminapi.summary.json b/SwagDigitalSalesRooms-adminapi.summary.json index c068d50..6faf772 100644 --- a/SwagDigitalSalesRooms-adminapi.summary.json +++ b/SwagDigitalSalesRooms-adminapi.summary.json @@ -20,7 +20,6 @@ "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics", - "/_action/user/logout", "/aggregate/dsr-appointment", "/aggregate/dsr-appointment-attendee", "/aggregate/dsr-appointment-request", @@ -30,7 +29,8 @@ "/aggregate/dsr-interaction", "/aggregate/dsr-presentation", "/aggregate/dsr-presentation-cms-page", - "/app-system/shop/verify", + "/aggregate/sales-channel-tracking-customer", + "/aggregate/sales-channel-tracking-order", "/dsr-appointment", "/dsr-appointment-attendee", "/dsr-appointment-attendee/{id}", @@ -49,6 +49,10 @@ "/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", @@ -57,7 +61,9 @@ "/search/dsr-cms-slide", "/search/dsr-interaction", "/search/dsr-presentation", - "/search/dsr-presentation-cms-page" + "/search/dsr-presentation-cms-page", + "/search/sales-channel-tracking-customer", + "/search/sales-channel-tracking-order" ], "schemas": [ "AbstractDynamicPageOpenedPayload", @@ -380,6 +386,10 @@ "SalesChannelLanguage", "SalesChannelPaymentMethod", "SalesChannelShippingMethod", + "SalesChannelTrackingCustomer", + "SalesChannelTrackingCustomerJsonApi", + "SalesChannelTrackingOrder", + "SalesChannelTrackingOrderJsonApi", "SalesChannelType", "SalesChannelTypeJsonApi", "Salutation",