diff --git a/.github/workflows/base_schema.yml b/.github/workflows/base_schema.yml index 1fba5ee..ede2338 100644 --- a/.github/workflows/base_schema.yml +++ b/.github/workflows/base_schema.yml @@ -98,7 +98,8 @@ jobs: ./.github/scripts/extract.sh adminapi.json adminapi.summary.json - name: Create PR - uses: peter-evans/create-pull-request@v6 + if: ${{ env.FILE_DIFFERENCE == 1 }} + uses: peter-evans/create-pull-request@v7 with: add-paths: | adminapi.json diff --git a/.github/workflows/manual_versioning.yml b/.github/workflows/manual_versioning.yml index 90ae818..b393508 100644 --- a/.github/workflows/manual_versioning.yml +++ b/.github/workflows/manual_versioning.yml @@ -1,4 +1,4 @@ -name: Manual version PRs +name: Manual versioning on: workflow_dispatch: diff --git a/SwagCommercial-adminapi.json b/SwagCommercial-adminapi.json index 22c2de5..5016f8a 100644 --- a/SwagCommercial-adminapi.json +++ b/SwagCommercial-adminapi.json @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.7.9999999-dev" + "version": "6.7.9.0" }, "servers": [ { @@ -27079,15 +27079,15 @@ } } }, - "/sales-channel-tracking-customer": { + "/spatial-render-config-size": { "get": { "tags": [ - "Sales Channel Tracking Customer", + "Spatial Render Config Size", "Experimental" ], - "summary": "List with basic information of Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingCustomerList", + "summary": "List with basic information of Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "", + "operationId": "getSpatialRenderConfigSizeList", "parameters": [ { "name": "limit", @@ -27116,7 +27116,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Tracking Customer resources.", + "description": "List of Spatial Render Config Size resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27135,7 +27135,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } ] @@ -27149,16 +27149,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-tracking-customer?limit=25" + "example": "/spatial-render-config-size?limit=25" }, "last": { - "example": "/sales-channel-tracking-customer?limit=25&page=11" + "example": "/spatial-render-config-size?limit=25&page=11" }, "next": { - "example": "/sales-channel-tracking-customer?limit=25&page=4" + "example": "/spatial-render-config-size?limit=25&page=4" }, "prev": { - "example": "/sales-channel-tracking-customer?limit=25&page=2" + "example": "/spatial-render-config-size?limit=25&page=2" } } } @@ -27179,7 +27179,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27194,12 +27194,12 @@ }, "post": { "tags": [ - "Sales Channel Tracking Customer", + "Spatial Render Config Size", "Experimental" ], - "summary": "Create a new Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "createSalesChannelTrackingCustomer", + "summary": "Create a new Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "", + "operationId": "createSpatialRenderConfigSize", "parameters": [ { "name": "_response", @@ -27218,14 +27218,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -27237,7 +27237,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27252,7 +27252,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27268,15 +27268,15 @@ } } }, - "/search/sales-channel-tracking-customer": { + "/search/spatial-render-config-size": { "post": { "tags": [ - "Sales Channel Tracking Customer", + "Spatial Render Config Size", "Experimental" ], - "summary": "Search for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "searchSalesChannelTrackingCustomer", + "summary": "Search for the Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "", + "operationId": "searchSpatialRenderConfigSize", "parameters": [ { "name": "sw-include-search-info", @@ -27304,7 +27304,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingCustomer", + "description": "List of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -27318,7 +27318,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27336,7 +27336,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27353,20 +27353,20 @@ } } }, - "/sales-channel-tracking-customer/{id}": { + "/spatial-render-config-size/{id}": { "get": { "tags": [ - "Sales Channel Tracking Customer", + "Spatial Render Config Size", "Experimental" ], - "summary": "Detailed information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingCustomer", + "summary": "Detailed information about a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "", + "operationId": "getSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -27376,7 +27376,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -27388,7 +27388,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27403,7 +27403,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27420,17 +27420,17 @@ }, "delete": { "tags": [ - "Sales Channel Tracking Customer", + "Spatial Render Config Size", "Experimental" ], - "summary": "Delete a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "deleteSalesChannelTrackingCustomer", + "summary": "Delete a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "", + "operationId": "deleteSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -27461,17 +27461,17 @@ }, "patch": { "tags": [ - "Sales Channel Tracking Customer", + "Spatial Render Config Size", "Experimental" ], - "summary": "Partially update information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "updateSalesChannelTrackingCustomer", + "summary": "Partially update information about a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "", + "operationId": "updateSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -27489,18 +27489,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Tracking Customer resource.", + "description": "Partially update information about a Spatial Render Config Size resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -27512,7 +27512,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27527,7 +27527,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27546,15 +27546,15 @@ } } }, - "/aggregate/sales-channel-tracking-customer": { + "/aggregate/spatial-render-config-size": { "post": { "tags": [ - "Sales Channel Tracking Customer", + "Spatial Render Config Size", "Experimental" ], - "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", + "summary": "Aggregate for the Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSpatialRenderConfigSize", "requestBody": { "required": true, "content": { @@ -27578,7 +27578,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingCustomer", + "description": "List of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -27592,7 +27592,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27610,7 +27610,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27627,15 +27627,15 @@ } } }, - "/sales-channel-tracking-order": { + "/spatial-scene": { "get": { "tags": [ - "Sales Channel Tracking Order", + "Spatial Scene", "Experimental" ], - "summary": "List with basic information of Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingOrderList", + "summary": "List with basic information of Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "", + "operationId": "getSpatialSceneList", "parameters": [ { "name": "limit", @@ -27664,7 +27664,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Tracking Order resources.", + "description": "List of Spatial Scene resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27683,7 +27683,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialScene" } } ] @@ -27697,16 +27697,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-tracking-order?limit=25" + "example": "/spatial-scene?limit=25" }, "last": { - "example": "/sales-channel-tracking-order?limit=25&page=11" + "example": "/spatial-scene?limit=25&page=11" }, "next": { - "example": "/sales-channel-tracking-order?limit=25&page=4" + "example": "/spatial-scene?limit=25&page=4" }, "prev": { - "example": "/sales-channel-tracking-order?limit=25&page=2" + "example": "/spatial-scene?limit=25&page=2" } } } @@ -27727,7 +27727,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -27742,12 +27742,12 @@ }, "post": { "tags": [ - "Sales Channel Tracking Order", + "Spatial Scene", "Experimental" ], - "summary": "Create a new Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "createSalesChannelTrackingOrder", + "summary": "Create a new Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "", + "operationId": "createSpatialScene", "parameters": [ { "name": "_response", @@ -27766,14 +27766,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -27785,7 +27785,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -27800,7 +27800,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -27816,15 +27816,15 @@ } } }, - "/search/sales-channel-tracking-order": { + "/search/spatial-scene": { "post": { "tags": [ - "Sales Channel Tracking Order", + "Spatial Scene", "Experimental" ], - "summary": "Search for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "searchSalesChannelTrackingOrder", + "summary": "Search for the Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "", + "operationId": "searchSpatialScene", "parameters": [ { "name": "sw-include-search-info", @@ -27852,7 +27852,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingOrder", + "description": "List of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -27866,7 +27866,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -27884,7 +27884,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -27901,20 +27901,20 @@ } } }, - "/sales-channel-tracking-order/{id}": { + "/spatial-scene/{id}": { "get": { "tags": [ - "Sales Channel Tracking Order", + "Spatial Scene", "Experimental" ], - "summary": "Detailed information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingOrder", + "summary": "Detailed information about a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "", + "operationId": "getSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -27924,7 +27924,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -27936,7 +27936,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -27951,7 +27951,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -27968,17 +27968,17 @@ }, "delete": { "tags": [ - "Sales Channel Tracking Order", + "Spatial Scene", "Experimental" ], - "summary": "Delete a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "deleteSalesChannelTrackingOrder", + "summary": "Delete a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "", + "operationId": "deleteSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -28009,17 +28009,17 @@ }, "patch": { "tags": [ - "Sales Channel Tracking Order", + "Spatial Scene", "Experimental" ], - "summary": "Partially update information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "updateSalesChannelTrackingOrder", + "summary": "Partially update information about a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "", + "operationId": "updateSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -28037,18 +28037,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Tracking Order resource.", + "description": "Partially update information about a Spatial Scene resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28060,7 +28060,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28075,7 +28075,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28094,15 +28094,15 @@ } } }, - "/aggregate/sales-channel-tracking-order": { + "/aggregate/spatial-scene": { "post": { "tags": [ - "Sales Channel Tracking Order", + "Spatial Scene", "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", + "summary": "Aggregate for the Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSpatialScene", "requestBody": { "required": true, "content": { @@ -28126,7 +28126,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingOrder", + "description": "List of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28140,7 +28140,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28158,7 +28158,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28175,15 +28175,15 @@ } } }, - "/spatial-render-config-size": { + "/spatial-scene-camera": { "get": { "tags": [ - "Spatial Render Config Size", + "Spatial Scene Camera", "Experimental" ], - "summary": "List with basic information of Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialRenderConfigSizeList", + "operationId": "getSpatialSceneCameraList", "parameters": [ { "name": "limit", @@ -28212,7 +28212,7 @@ ], "responses": { "200": { - "description": "List of Spatial Render Config Size resources.", + "description": "List of Spatial Scene Camera resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28231,7 +28231,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialSceneCamera" } } ] @@ -28245,16 +28245,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-render-config-size?limit=25" + "example": "/spatial-scene-camera?limit=25" }, "last": { - "example": "/spatial-render-config-size?limit=25&page=11" + "example": "/spatial-scene-camera?limit=25&page=11" }, "next": { - "example": "/spatial-render-config-size?limit=25&page=4" + "example": "/spatial-scene-camera?limit=25&page=4" }, "prev": { - "example": "/spatial-render-config-size?limit=25&page=2" + "example": "/spatial-scene-camera?limit=25&page=2" } } } @@ -28275,7 +28275,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28290,12 +28290,12 @@ }, "post": { "tags": [ - "Spatial Render Config Size", + "Spatial Scene Camera", "Experimental" ], - "summary": "Create a new Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialRenderConfigSize", + "operationId": "createSpatialSceneCamera", "parameters": [ { "name": "_response", @@ -28314,14 +28314,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } }, "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -28333,7 +28333,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28348,7 +28348,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28364,15 +28364,15 @@ } } }, - "/search/spatial-render-config-size": { + "/search/spatial-scene-camera": { "post": { "tags": [ - "Spatial Render Config Size", + "Spatial Scene Camera", "Experimental" ], - "summary": "Search for the Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialRenderConfigSize", + "operationId": "searchSpatialSceneCamera", "parameters": [ { "name": "sw-include-search-info", @@ -28400,7 +28400,7 @@ }, "responses": { "200": { - "description": "List of SpatialRenderConfigSize", + "description": "List of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -28414,7 +28414,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28432,7 +28432,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28449,20 +28449,20 @@ } } }, - "/spatial-render-config-size/{id}": { + "/spatial-scene-camera/{id}": { "get": { "tags": [ - "Spatial Render Config Size", + "Spatial Scene Camera", "Experimental" ], - "summary": "Detailed information about a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Spatial Scene Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialRenderConfigSize", + "operationId": "getSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -28472,7 +28472,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -28484,7 +28484,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28499,7 +28499,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28516,17 +28516,17 @@ }, "delete": { "tags": [ - "Spatial Render Config Size", + "Spatial Scene Camera", "Experimental" ], - "summary": "Delete a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Spatial Scene Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialRenderConfigSize", + "operationId": "deleteSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -28557,17 +28557,17 @@ }, "patch": { "tags": [ - "Spatial Render Config Size", + "Spatial Scene Camera", "Experimental" ], - "summary": "Partially update information about a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Spatial Scene Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialRenderConfigSize", + "operationId": "updateSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -28585,18 +28585,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Render Config Size resource.", + "description": "Partially update information about a Spatial Scene Camera resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } }, "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -28608,7 +28608,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28623,7 +28623,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28642,15 +28642,15 @@ } } }, - "/aggregate/spatial-render-config-size": { + "/aggregate/spatial-scene-camera": { "post": { "tags": [ - "Spatial Render Config Size", + "Spatial Scene Camera", "Experimental" ], - "summary": "Aggregate for the Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialRenderConfigSize", + "operationId": "aggregateSpatialSceneCamera", "requestBody": { "required": true, "content": { @@ -28674,7 +28674,7 @@ }, "responses": { "200": { - "description": "List of SpatialRenderConfigSize", + "description": "List of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -28688,7 +28688,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28706,7 +28706,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28723,15 +28723,15 @@ } } }, - "/spatial-scene": { + "/spatial-scene-group": { "get": { "tags": [ - "Spatial Scene", + "Spatial Scene Group", "Experimental" ], - "summary": "List with basic information of Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneList", + "operationId": "getSpatialSceneGroupList", "parameters": [ { "name": "limit", @@ -28760,7 +28760,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene resources.", + "description": "List of Spatial Scene Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28779,7 +28779,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneGroup" } } ] @@ -28793,16 +28793,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene?limit=25" + "example": "/spatial-scene-group?limit=25" }, "last": { - "example": "/spatial-scene?limit=25&page=11" + "example": "/spatial-scene-group?limit=25&page=11" }, "next": { - "example": "/spatial-scene?limit=25&page=4" + "example": "/spatial-scene-group?limit=25&page=4" }, "prev": { - "example": "/spatial-scene?limit=25&page=2" + "example": "/spatial-scene-group?limit=25&page=2" } } } @@ -28823,7 +28823,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -28838,12 +28838,12 @@ }, "post": { "tags": [ - "Spatial Scene", + "Spatial Scene Group", "Experimental" ], - "summary": "Create a new Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialScene", + "operationId": "createSpatialSceneGroup", "parameters": [ { "name": "_response", @@ -28862,14 +28862,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } }, "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -28881,7 +28881,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -28896,7 +28896,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -28912,15 +28912,15 @@ } } }, - "/search/spatial-scene": { + "/search/spatial-scene-group": { "post": { "tags": [ - "Spatial Scene", + "Spatial Scene Group", "Experimental" ], - "summary": "Search for the Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialScene", + "operationId": "searchSpatialSceneGroup", "parameters": [ { "name": "sw-include-search-info", @@ -28948,7 +28948,7 @@ }, "responses": { "200": { - "description": "List of SpatialScene", + "description": "List of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -28962,7 +28962,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -28980,7 +28980,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -28997,20 +28997,20 @@ } } }, - "/spatial-scene/{id}": { + "/spatial-scene-group/{id}": { "get": { "tags": [ - "Spatial Scene", + "Spatial Scene Group", "Experimental" ], - "summary": "Detailed information about a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialScene", + "operationId": "getSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -29020,7 +29020,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -29032,7 +29032,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29047,7 +29047,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29064,17 +29064,17 @@ }, "delete": { "tags": [ - "Spatial Scene", + "Spatial Scene Group", "Experimental" ], - "summary": "Delete a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialScene", + "operationId": "deleteSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -29105,17 +29105,17 @@ }, "patch": { "tags": [ - "Spatial Scene", + "Spatial Scene Group", "Experimental" ], - "summary": "Partially update information about a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialScene", + "operationId": "updateSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -29133,18 +29133,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene resource.", + "description": "Partially update information about a Spatial Scene Group resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } }, "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -29156,7 +29156,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29171,7 +29171,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29190,15 +29190,15 @@ } } }, - "/aggregate/spatial-scene": { + "/aggregate/spatial-scene-group": { "post": { "tags": [ - "Spatial Scene", + "Spatial Scene Group", "Experimental" ], - "summary": "Aggregate for the Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialScene", + "operationId": "aggregateSpatialSceneGroup", "requestBody": { "required": true, "content": { @@ -29222,7 +29222,7 @@ }, "responses": { "200": { - "description": "List of SpatialScene", + "description": "List of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -29236,7 +29236,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29254,7 +29254,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29271,15 +29271,15 @@ } } }, - "/spatial-scene-camera": { + "/spatial-scene-light": { "get": { "tags": [ - "Spatial Scene Camera", + "Spatial Scene Light", "Experimental" ], - "summary": "List with basic information of Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneCameraList", + "operationId": "getSpatialSceneLightList", "parameters": [ { "name": "limit", @@ -29308,7 +29308,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Camera resources.", + "description": "List of Spatial Scene Light resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29327,7 +29327,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneLight" } } ] @@ -29341,16 +29341,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-camera?limit=25" + "example": "/spatial-scene-light?limit=25" }, "last": { - "example": "/spatial-scene-camera?limit=25&page=11" + "example": "/spatial-scene-light?limit=25&page=11" }, "next": { - "example": "/spatial-scene-camera?limit=25&page=4" + "example": "/spatial-scene-light?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-camera?limit=25&page=2" + "example": "/spatial-scene-light?limit=25&page=2" } } } @@ -29371,7 +29371,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29386,12 +29386,12 @@ }, "post": { "tags": [ - "Spatial Scene Camera", + "Spatial Scene Light", "Experimental" ], - "summary": "Create a new Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneCamera", + "operationId": "createSpatialSceneLight", "parameters": [ { "name": "_response", @@ -29410,14 +29410,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneLight" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29429,7 +29429,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29444,7 +29444,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29460,15 +29460,15 @@ } } }, - "/search/spatial-scene-camera": { + "/search/spatial-scene-light": { "post": { "tags": [ - "Spatial Scene Camera", + "Spatial Scene Light", "Experimental" ], - "summary": "Search for the Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneCamera", + "operationId": "searchSpatialSceneLight", "parameters": [ { "name": "sw-include-search-info", @@ -29496,7 +29496,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneCamera", + "description": "List of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29510,7 +29510,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29528,7 +29528,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29545,20 +29545,20 @@ } } }, - "/spatial-scene-camera/{id}": { + "/spatial-scene-light/{id}": { "get": { "tags": [ - "Spatial Scene Camera", + "Spatial Scene Light", "Experimental" ], - "summary": "Detailed information about a Spatial Scene Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Spatial Scene Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneCamera", + "operationId": "getSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -29568,7 +29568,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29580,7 +29580,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29595,7 +29595,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29612,17 +29612,17 @@ }, "delete": { "tags": [ - "Spatial Scene Camera", + "Spatial Scene Light", "Experimental" ], - "summary": "Delete a Spatial Scene Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Spatial Scene Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneCamera", + "operationId": "deleteSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -29653,17 +29653,17 @@ }, "patch": { "tags": [ - "Spatial Scene Camera", + "Spatial Scene Light", "Experimental" ], - "summary": "Partially update information about a Spatial Scene Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Spatial Scene Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneCamera", + "operationId": "updateSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -29681,18 +29681,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Camera resource.", + "description": "Partially update information about a Spatial Scene Light resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneLight" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29704,7 +29704,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29719,7 +29719,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29738,15 +29738,15 @@ } } }, - "/aggregate/spatial-scene-camera": { + "/aggregate/spatial-scene-light": { "post": { "tags": [ - "Spatial Scene Camera", + "Spatial Scene Light", "Experimental" ], - "summary": "Aggregate for the Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialSceneCamera", + "operationId": "aggregateSpatialSceneLight", "requestBody": { "required": true, "content": { @@ -29770,7 +29770,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneCamera", + "description": "List of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29784,7 +29784,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29802,7 +29802,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29819,15 +29819,15 @@ } } }, - "/spatial-scene-group": { + "/spatial-scene-material": { "get": { "tags": [ - "Spatial Scene Group", + "Spatial Scene Material", "Experimental" ], - "summary": "List with basic information of Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Spatial Scene Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneGroupList", + "operationId": "getSpatialSceneMaterialList", "parameters": [ { "name": "limit", @@ -29856,7 +29856,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Group resources.", + "description": "List of Spatial Scene Material resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29875,7 +29875,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } ] @@ -29889,16 +29889,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-group?limit=25" + "example": "/spatial-scene-material?limit=25" }, "last": { - "example": "/spatial-scene-group?limit=25&page=11" + "example": "/spatial-scene-material?limit=25&page=11" }, "next": { - "example": "/spatial-scene-group?limit=25&page=4" + "example": "/spatial-scene-material?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-group?limit=25&page=2" + "example": "/spatial-scene-material?limit=25&page=2" } } } @@ -29919,7 +29919,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -29934,12 +29934,12 @@ }, "post": { "tags": [ - "Spatial Scene Group", + "Spatial Scene Material", "Experimental" ], - "summary": "Create a new Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Spatial Scene Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneGroup", + "operationId": "createSpatialSceneMaterial", "parameters": [ { "name": "_response", @@ -29958,14 +29958,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -29977,7 +29977,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -29992,7 +29992,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30008,15 +30008,15 @@ } } }, - "/search/spatial-scene-group": { + "/search/spatial-scene-material": { "post": { "tags": [ - "Spatial Scene Group", + "Spatial Scene Material", "Experimental" ], - "summary": "Search for the Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Spatial Scene Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneGroup", + "operationId": "searchSpatialSceneMaterial", "parameters": [ { "name": "sw-include-search-info", @@ -30044,7 +30044,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneGroup", + "description": "List of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -30058,7 +30058,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30076,7 +30076,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30093,20 +30093,20 @@ } } }, - "/spatial-scene-group/{id}": { + "/spatial-scene-material/{id}": { "get": { "tags": [ - "Spatial Scene Group", + "Spatial Scene Material", "Experimental" ], - "summary": "Detailed information about a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Spatial Scene Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneGroup", + "operationId": "getSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -30116,7 +30116,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -30128,7 +30128,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30143,7 +30143,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30160,17 +30160,17 @@ }, "delete": { "tags": [ - "Spatial Scene Group", + "Spatial Scene Material", "Experimental" ], - "summary": "Delete a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Spatial Scene Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneGroup", + "operationId": "deleteSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -30201,17 +30201,17 @@ }, "patch": { "tags": [ - "Spatial Scene Group", + "Spatial Scene Material", "Experimental" ], - "summary": "Partially update information about a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Spatial Scene Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneGroup", + "operationId": "updateSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -30229,18 +30229,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Group resource.", + "description": "Partially update information about a Spatial Scene Material resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -30252,7 +30252,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30267,7 +30267,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30286,15 +30286,15 @@ } } }, - "/aggregate/spatial-scene-group": { + "/aggregate/spatial-scene-material": { "post": { "tags": [ - "Spatial Scene Group", + "Spatial Scene Material", "Experimental" ], - "summary": "Aggregate for the Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Spatial Scene Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialSceneGroup", + "operationId": "aggregateSpatialSceneMaterial", "requestBody": { "required": true, "content": { @@ -30318,7 +30318,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneGroup", + "description": "List of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -30332,7 +30332,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30350,7 +30350,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30367,15 +30367,15 @@ } } }, - "/spatial-scene-light": { + "/spatial-scene-object": { "get": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Object", "Experimental" ], - "summary": "List with basic information of Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneLightList", + "operationId": "getSpatialSceneObjectList", "parameters": [ { "name": "limit", @@ -30404,7 +30404,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Light resources.", + "description": "List of Spatial Scene Object resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30423,7 +30423,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneObject" } } ] @@ -30437,16 +30437,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-light?limit=25" + "example": "/spatial-scene-object?limit=25" }, "last": { - "example": "/spatial-scene-light?limit=25&page=11" + "example": "/spatial-scene-object?limit=25&page=11" }, "next": { - "example": "/spatial-scene-light?limit=25&page=4" + "example": "/spatial-scene-object?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-light?limit=25&page=2" + "example": "/spatial-scene-object?limit=25&page=2" } } } @@ -30467,7 +30467,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30482,12 +30482,12 @@ }, "post": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Object", "Experimental" ], - "summary": "Create a new Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneLight", + "operationId": "createSpatialSceneObject", "parameters": [ { "name": "_response", @@ -30506,14 +30506,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneObject" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -30525,7 +30525,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30540,7 +30540,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30556,15 +30556,15 @@ } } }, - "/search/spatial-scene-light": { + "/search/spatial-scene-object": { "post": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Object", "Experimental" ], - "summary": "Search for the Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneLight", + "operationId": "searchSpatialSceneObject", "parameters": [ { "name": "sw-include-search-info", @@ -30592,7 +30592,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneLight", + "description": "List of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -30606,7 +30606,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30624,7 +30624,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30641,20 +30641,20 @@ } } }, - "/spatial-scene-light/{id}": { + "/spatial-scene-object/{id}": { "get": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Object", "Experimental" ], - "summary": "Detailed information about a Spatial Scene Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Spatial Scene Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneLight", + "operationId": "getSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -30664,7 +30664,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -30676,7 +30676,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30691,7 +30691,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30708,17 +30708,17 @@ }, "delete": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Object", "Experimental" ], - "summary": "Delete a Spatial Scene Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Spatial Scene Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneLight", + "operationId": "deleteSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -30749,17 +30749,17 @@ }, "patch": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Object", "Experimental" ], - "summary": "Partially update information about a Spatial Scene Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Spatial Scene Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneLight", + "operationId": "updateSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -30777,18 +30777,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Light resource.", + "description": "Partially update information about a Spatial Scene Object resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneObject" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -30800,7 +30800,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30815,7 +30815,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30834,15 +30834,15 @@ } } }, - "/aggregate/spatial-scene-light": { + "/aggregate/spatial-scene-object": { "post": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Object", "Experimental" ], - "summary": "Aggregate for the Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialSceneLight", + "operationId": "aggregateSpatialSceneObject", "requestBody": { "required": true, "content": { @@ -30866,7 +30866,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneLight", + "description": "List of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -30880,7 +30880,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30898,7 +30898,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30915,15 +30915,15 @@ } } }, - "/spatial-scene-material": { + "/spatial-scene-primitive": { "get": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Primitive", "Experimental" ], - "summary": "List with basic information of Spatial Scene Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Spatial Scene Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneMaterialList", + "operationId": "getSpatialScenePrimitiveList", "parameters": [ { "name": "limit", @@ -30952,7 +30952,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Material resources.", + "description": "List of Spatial Scene Primitive resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30971,7 +30971,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } ] @@ -30985,16 +30985,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-material?limit=25" + "example": "/spatial-scene-primitive?limit=25" }, "last": { - "example": "/spatial-scene-material?limit=25&page=11" + "example": "/spatial-scene-primitive?limit=25&page=11" }, "next": { - "example": "/spatial-scene-material?limit=25&page=4" + "example": "/spatial-scene-primitive?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-material?limit=25&page=2" + "example": "/spatial-scene-primitive?limit=25&page=2" } } } @@ -31015,7 +31015,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31030,12 +31030,12 @@ }, "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Primitive", "Experimental" ], - "summary": "Create a new Spatial Scene Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Spatial Scene Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneMaterial", + "operationId": "createSpatialScenePrimitive", "parameters": [ { "name": "_response", @@ -31054,14 +31054,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31073,7 +31073,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31088,7 +31088,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31104,15 +31104,15 @@ } } }, - "/search/spatial-scene-material": { + "/search/spatial-scene-primitive": { "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Primitive", "Experimental" ], - "summary": "Search for the Spatial Scene Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Spatial Scene Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneMaterial", + "operationId": "searchSpatialScenePrimitive", "parameters": [ { "name": "sw-include-search-info", @@ -31140,7 +31140,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneMaterial", + "description": "List of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31154,7 +31154,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31172,7 +31172,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31189,20 +31189,20 @@ } } }, - "/spatial-scene-material/{id}": { + "/spatial-scene-primitive/{id}": { "get": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Primitive", "Experimental" ], - "summary": "Detailed information about a Spatial Scene Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Spatial Scene Primitive resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneMaterial", + "operationId": "getSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -31212,7 +31212,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31224,7 +31224,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31239,7 +31239,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31256,17 +31256,17 @@ }, "delete": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Primitive", "Experimental" ], - "summary": "Delete a Spatial Scene Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Spatial Scene Primitive resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneMaterial", + "operationId": "deleteSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -31297,17 +31297,17 @@ }, "patch": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Primitive", "Experimental" ], - "summary": "Partially update information about a Spatial Scene Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Spatial Scene Primitive resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneMaterial", + "operationId": "updateSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -31325,18 +31325,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Material resource.", + "description": "Partially update information about a Spatial Scene Primitive resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31348,7 +31348,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31363,7 +31363,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31382,15 +31382,15 @@ } } }, - "/aggregate/spatial-scene-material": { + "/aggregate/spatial-scene-primitive": { "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Primitive", "Experimental" ], - "summary": "Aggregate for the Spatial Scene Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Spatial Scene Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialSceneMaterial", + "operationId": "aggregateSpatialScenePrimitive", "requestBody": { "required": true, "content": { @@ -31414,7 +31414,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneMaterial", + "description": "List of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31428,7 +31428,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31446,7 +31446,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31463,15 +31463,15 @@ } } }, - "/spatial-scene-object": { + "/sso-provider": { "get": { "tags": [ - "Spatial Scene Object", + "Sso Provider", "Experimental" ], - "summary": "List with basic information of Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneObjectList", + "operationId": "getSsoProviderList", "parameters": [ { "name": "limit", @@ -31500,7 +31500,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Object resources.", + "description": "List of Sso Provider resources.", "content": { "application/vnd.api+json": { "schema": { @@ -31519,7 +31519,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SsoProvider" } } ] @@ -31533,16 +31533,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-object?limit=25" + "example": "/sso-provider?limit=25" }, "last": { - "example": "/spatial-scene-object?limit=25&page=11" + "example": "/sso-provider?limit=25&page=11" }, "next": { - "example": "/spatial-scene-object?limit=25&page=4" + "example": "/sso-provider?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-object?limit=25&page=2" + "example": "/sso-provider?limit=25&page=2" } } } @@ -31563,7 +31563,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31578,12 +31578,12 @@ }, "post": { "tags": [ - "Spatial Scene Object", + "Sso Provider", "Experimental" ], - "summary": "Create a new Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneObject", + "operationId": "createSsoProvider", "parameters": [ { "name": "_response", @@ -31602,14 +31602,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SsoProvider" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -31621,7 +31621,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31636,7 +31636,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31652,15 +31652,15 @@ } } }, - "/search/spatial-scene-object": { + "/search/sso-provider": { "post": { "tags": [ - "Spatial Scene Object", + "Sso Provider", "Experimental" ], - "summary": "Search for the Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneObject", + "operationId": "searchSsoProvider", "parameters": [ { "name": "sw-include-search-info", @@ -31688,7 +31688,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneObject", + "description": "List of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -31702,7 +31702,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31720,7 +31720,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31737,20 +31737,20 @@ } } }, - "/spatial-scene-object/{id}": { + "/sso-provider/{id}": { "get": { "tags": [ - "Spatial Scene Object", + "Sso Provider", "Experimental" ], - "summary": "Detailed information about a Spatial Scene Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Sso Provider resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneObject", + "operationId": "getSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -31760,7 +31760,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -31772,7 +31772,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31787,7 +31787,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31804,17 +31804,17 @@ }, "delete": { "tags": [ - "Spatial Scene Object", + "Sso Provider", "Experimental" ], - "summary": "Delete a Spatial Scene Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Sso Provider resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneObject", + "operationId": "deleteSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -31845,17 +31845,17 @@ }, "patch": { "tags": [ - "Spatial Scene Object", + "Sso Provider", "Experimental" ], - "summary": "Partially update information about a Spatial Scene Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Sso Provider resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneObject", + "operationId": "updateSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -31873,18 +31873,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Object resource.", + "description": "Partially update information about a Sso Provider resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SsoProvider" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -31896,7 +31896,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31911,7 +31911,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31930,15 +31930,15 @@ } } }, - "/aggregate/spatial-scene-object": { + "/aggregate/sso-provider": { "post": { "tags": [ - "Spatial Scene Object", + "Sso Provider", "Experimental" ], - "summary": "Aggregate for the Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSpatialSceneObject", + "operationId": "aggregateSsoProvider", "requestBody": { "required": true, "content": { @@ -31962,7 +31962,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneObject", + "description": "List of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -31976,7 +31976,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31994,7 +31994,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32011,15 +32011,15 @@ } } }, - "/spatial-scene-primitive": { + "/sso-provider-customer": { "get": { "tags": [ - "Spatial Scene Primitive", + "Sso Provider Customer", "Experimental" ], - "summary": "List with basic information of Spatial Scene Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialScenePrimitiveList", + "operationId": "getSsoProviderCustomerList", "parameters": [ { "name": "limit", @@ -32048,7 +32048,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Primitive resources.", + "description": "List of Sso Provider Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32067,7 +32067,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProviderCustomer" } } ] @@ -32081,16 +32081,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-primitive?limit=25" + "example": "/sso-provider-customer?limit=25" }, "last": { - "example": "/spatial-scene-primitive?limit=25&page=11" + "example": "/sso-provider-customer?limit=25&page=11" }, "next": { - "example": "/spatial-scene-primitive?limit=25&page=4" + "example": "/sso-provider-customer?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-primitive?limit=25&page=2" + "example": "/sso-provider-customer?limit=25&page=2" } } } @@ -32111,7 +32111,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32126,12 +32126,12 @@ }, "post": { "tags": [ - "Spatial Scene Primitive", + "Sso Provider Customer", "Experimental" ], - "summary": "Create a new Spatial Scene Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialScenePrimitive", + "operationId": "createSsoProviderCustomer", "parameters": [ { "name": "_response", @@ -32150,14 +32150,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } }, "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32169,7 +32169,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32184,7 +32184,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32200,15 +32200,15 @@ } } }, - "/search/spatial-scene-primitive": { + "/search/sso-provider-customer": { "post": { "tags": [ - "Spatial Scene Primitive", + "Sso Provider Customer", "Experimental" ], - "summary": "Search for the Spatial Scene Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialScenePrimitive", + "operationId": "searchSsoProviderCustomer", "parameters": [ { "name": "sw-include-search-info", @@ -32236,7 +32236,7 @@ }, "responses": { "200": { - "description": "List of SpatialScenePrimitive", + "description": "List of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32250,7 +32250,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32268,7 +32268,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32285,20 +32285,20 @@ } } }, - "/spatial-scene-primitive/{id}": { + "/sso-provider-customer/{id}": { "get": { "tags": [ - "Spatial Scene Primitive", + "Sso Provider Customer", "Experimental" ], - "summary": "Detailed information about a Spatial Scene Primitive resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialScenePrimitive", + "operationId": "getSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -32308,7 +32308,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32320,7 +32320,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32335,7 +32335,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32352,17 +32352,17 @@ }, "delete": { "tags": [ - "Spatial Scene Primitive", + "Sso Provider Customer", "Experimental" ], - "summary": "Delete a Spatial Scene Primitive resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialScenePrimitive", + "operationId": "deleteSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -32393,17 +32393,17 @@ }, "patch": { "tags": [ - "Spatial Scene Primitive", + "Sso Provider Customer", "Experimental" ], - "summary": "Partially update information about a Spatial Scene Primitive resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialScenePrimitive", + "operationId": "updateSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -32421,18 +32421,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Primitive resource.", + "description": "Partially update information about a Sso Provider Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } }, "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32444,7 +32444,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32459,7 +32459,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32478,15 +32478,15 @@ } } }, - "/aggregate/spatial-scene-primitive": { + "/aggregate/sso-provider-customer": { "post": { "tags": [ - "Spatial Scene Primitive", + "Sso Provider Customer", "Experimental" ], - "summary": "Aggregate for the Spatial Scene Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Sso Provider 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.6.10.0", - "operationId": "aggregateSpatialScenePrimitive", + "operationId": "aggregateSsoProviderCustomer", "requestBody": { "required": true, "content": { @@ -32510,7 +32510,7 @@ }, "responses": { "200": { - "description": "List of SpatialScenePrimitive", + "description": "List of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32524,7 +32524,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32542,7 +32542,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32559,15 +32559,14 @@ } } }, - "/sso-provider": { + "/subscription": { "get": { "tags": [ - "Sso Provider", - "Experimental" + "Subscription" ], - "summary": "List with basic information of Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Subscription resources.", "description": "", - "operationId": "getSsoProviderList", + "operationId": "getSubscriptionList", "parameters": [ { "name": "limit", @@ -32596,7 +32595,7 @@ ], "responses": { "200": { - "description": "List of Sso Provider resources.", + "description": "List of Subscription resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32615,7 +32614,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Subscription" } } ] @@ -32629,16 +32628,16 @@ "type": "object", "properties": { "first": { - "example": "/sso-provider?limit=25" + "example": "/subscription?limit=25" }, "last": { - "example": "/sso-provider?limit=25&page=11" + "example": "/subscription?limit=25&page=11" }, "next": { - "example": "/sso-provider?limit=25&page=4" + "example": "/subscription?limit=25&page=4" }, "prev": { - "example": "/sso-provider?limit=25&page=2" + "example": "/subscription?limit=25&page=2" } } } @@ -32659,7 +32658,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Subscription" } } } @@ -32674,12 +32673,11 @@ }, "post": { "tags": [ - "Sso Provider", - "Experimental" + "Subscription" ], - "summary": "Create a new Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Subscription resources.", "description": "", - "operationId": "createSsoProvider", + "operationId": "createSubscription", "parameters": [ { "name": "_response", @@ -32698,14 +32696,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -32717,7 +32715,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Subscription" } } } @@ -32732,7 +32730,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Subscription" } } } @@ -32748,15 +32746,14 @@ } } }, - "/search/sso-provider": { + "/search/subscription": { "post": { "tags": [ - "Sso Provider", - "Experimental" + "Subscription" ], - "summary": "Search for the Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Subscription resources.", "description": "", - "operationId": "searchSsoProvider", + "operationId": "searchSubscription", "parameters": [ { "name": "sw-include-search-info", @@ -32784,7 +32781,7 @@ }, "responses": { "200": { - "description": "List of SsoProvider", + "description": "List of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -32798,7 +32795,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Subscription" } } } @@ -32816,7 +32813,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Subscription" } } } @@ -32833,20 +32830,19 @@ } } }, - "/sso-provider/{id}": { + "/subscription/{id}": { "get": { "tags": [ - "Sso Provider", - "Experimental" + "Subscription" ], - "summary": "Detailed information about a Sso Provider resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Subscription resource.", "description": "", - "operationId": "getSsoProvider", + "operationId": "getSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -32856,7 +32852,7 @@ ], "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -32868,7 +32864,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Subscription" } } } @@ -32883,7 +32879,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Subscription" } } } @@ -32900,17 +32896,16 @@ }, "delete": { "tags": [ - "Sso Provider", - "Experimental" + "Subscription" ], - "summary": "Delete a Sso Provider resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Subscription resource.", "description": "", - "operationId": "deleteSsoProvider", + "operationId": "deleteSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -32941,17 +32936,16 @@ }, "patch": { "tags": [ - "Sso Provider", - "Experimental" + "Subscription" ], - "summary": "Partially update information about a Sso Provider resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Subscription resource.", "description": "", - "operationId": "updateSsoProvider", + "operationId": "updateSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -32969,18 +32963,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sso Provider resource.", + "description": "Partially update information about a Subscription resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -32992,7 +32986,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Subscription" } } } @@ -33007,7 +33001,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Subscription" } } } @@ -33026,15 +33020,14 @@ } } }, - "/aggregate/sso-provider": { + "/aggregate/subscription": { "post": { "tags": [ - "Sso Provider", - "Experimental" + "Subscription" ], - "summary": "Aggregate for the Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Subscription resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSsoProvider", + "operationId": "aggregateSubscription", "requestBody": { "required": true, "content": { @@ -33058,7 +33051,7 @@ }, "responses": { "200": { - "description": "List of SsoProvider", + "description": "List of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -33072,7 +33065,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Subscription" } } } @@ -33090,7 +33083,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Subscription" } } } @@ -33107,15 +33100,14 @@ } } }, - "/sso-provider-customer": { + "/subscription-address": { "get": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Subscription Address" ], - "summary": "List with basic information of Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "List with basic information of Subscription Address resources.", "description": "", - "operationId": "getSsoProviderCustomerList", + "operationId": "getSubscriptionAddressList", "parameters": [ { "name": "limit", @@ -33144,7 +33136,7 @@ ], "responses": { "200": { - "description": "List of Sso Provider Customer resources.", + "description": "List of Subscription Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33163,7 +33155,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SubscriptionAddress" } } ] @@ -33177,16 +33169,16 @@ "type": "object", "properties": { "first": { - "example": "/sso-provider-customer?limit=25" + "example": "/subscription-address?limit=25" }, "last": { - "example": "/sso-provider-customer?limit=25&page=11" + "example": "/subscription-address?limit=25&page=11" }, "next": { - "example": "/sso-provider-customer?limit=25&page=4" + "example": "/subscription-address?limit=25&page=4" }, "prev": { - "example": "/sso-provider-customer?limit=25&page=2" + "example": "/subscription-address?limit=25&page=2" } } } @@ -33207,7 +33199,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33222,12 +33214,11 @@ }, "post": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Subscription Address" ], - "summary": "Create a new Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Create a new Subscription Address resources.", "description": "", - "operationId": "createSsoProviderCustomer", + "operationId": "createSubscriptionAddress", "parameters": [ { "name": "_response", @@ -33246,14 +33237,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SubscriptionAddress" } } } }, "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -33265,7 +33256,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33280,7 +33271,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33296,15 +33287,14 @@ } } }, - "/search/sso-provider-customer": { + "/search/subscription-address": { "post": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Subscription Address" ], - "summary": "Search for the Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Search for the Subscription Address resources.", "description": "", - "operationId": "searchSsoProviderCustomer", + "operationId": "searchSubscriptionAddress", "parameters": [ { "name": "sw-include-search-info", @@ -33332,7 +33322,7 @@ }, "responses": { "200": { - "description": "List of SsoProviderCustomer", + "description": "List of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -33346,7 +33336,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33364,7 +33354,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33381,20 +33371,19 @@ } } }, - "/sso-provider-customer/{id}": { + "/subscription-address/{id}": { "get": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Subscription Address" ], - "summary": "Detailed information about a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Detailed information about a Subscription Address resource.", "description": "", - "operationId": "getSsoProviderCustomer", + "operationId": "getSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -33404,7 +33393,7 @@ ], "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -33416,7 +33405,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33431,7 +33420,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33448,17 +33437,16 @@ }, "delete": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Subscription Address" ], - "summary": "Delete a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Delete a Subscription Address resource.", "description": "", - "operationId": "deleteSsoProviderCustomer", + "operationId": "deleteSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -33489,17 +33477,16 @@ }, "patch": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Subscription Address" ], - "summary": "Partially update information about a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Partially update information about a Subscription Address resource.", "description": "", - "operationId": "updateSsoProviderCustomer", + "operationId": "updateSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -33517,18 +33504,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sso Provider Customer resource.", + "description": "Partially update information about a Subscription Address resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SubscriptionAddress" } } } }, "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -33540,7 +33527,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33555,7 +33542,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33574,15 +33561,14 @@ } } }, - "/aggregate/sso-provider-customer": { + "/aggregate/subscription-address": { "post": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Subscription Address" ], - "summary": "Aggregate for the Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "summary": "Aggregate for the Subscription Address resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSsoProviderCustomer", + "operationId": "aggregateSubscriptionAddress", "requestBody": { "required": true, "content": { @@ -33606,7 +33592,7 @@ }, "responses": { "200": { - "description": "List of SsoProviderCustomer", + "description": "List of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -33620,7 +33606,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33638,7 +33624,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33655,14 +33641,14 @@ } } }, - "/subscription": { + "/subscription-customer": { "get": { "tags": [ - "Subscription" + "Subscription Customer" ], - "summary": "List with basic information of Subscription resources.", + "summary": "List with basic information of Subscription Customer resources.", "description": "", - "operationId": "getSubscriptionList", + "operationId": "getSubscriptionCustomerList", "parameters": [ { "name": "limit", @@ -33691,7 +33677,7 @@ ], "responses": { "200": { - "description": "List of Subscription resources.", + "description": "List of Subscription Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33710,7 +33696,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionCustomer" } } ] @@ -33724,16 +33710,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription?limit=25" + "example": "/subscription-customer?limit=25" }, "last": { - "example": "/subscription?limit=25&page=11" + "example": "/subscription-customer?limit=25&page=11" }, "next": { - "example": "/subscription?limit=25&page=4" + "example": "/subscription-customer?limit=25&page=4" }, "prev": { - "example": "/subscription?limit=25&page=2" + "example": "/subscription-customer?limit=25&page=2" } } } @@ -33754,7 +33740,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33769,11 +33755,11 @@ }, "post": { "tags": [ - "Subscription" + "Subscription Customer" ], - "summary": "Create a new Subscription resources.", + "summary": "Create a new Subscription Customer resources.", "description": "", - "operationId": "createSubscription", + "operationId": "createSubscriptionCustomer", "parameters": [ { "name": "_response", @@ -33792,14 +33778,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -33811,7 +33797,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33826,7 +33812,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33842,14 +33828,14 @@ } } }, - "/search/subscription": { + "/search/subscription-customer": { "post": { "tags": [ - "Subscription" + "Subscription Customer" ], - "summary": "Search for the Subscription resources.", + "summary": "Search for the Subscription Customer resources.", "description": "", - "operationId": "searchSubscription", + "operationId": "searchSubscriptionCustomer", "parameters": [ { "name": "sw-include-search-info", @@ -33877,7 +33863,7 @@ }, "responses": { "200": { - "description": "List of Subscription", + "description": "List of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -33891,7 +33877,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33909,7 +33895,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33926,19 +33912,19 @@ } } }, - "/subscription/{id}": { + "/subscription-customer/{id}": { "get": { "tags": [ - "Subscription" + "Subscription Customer" ], - "summary": "Detailed information about a Subscription resource.", + "summary": "Detailed information about a Subscription Customer resource.", "description": "", - "operationId": "getSubscription", + "operationId": "getSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -33948,7 +33934,7 @@ ], "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -33960,7 +33946,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33975,7 +33961,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33992,16 +33978,16 @@ }, "delete": { "tags": [ - "Subscription" + "Subscription Customer" ], - "summary": "Delete a Subscription resource.", + "summary": "Delete a Subscription Customer resource.", "description": "", - "operationId": "deleteSubscription", + "operationId": "deleteSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -34032,16 +34018,16 @@ }, "patch": { "tags": [ - "Subscription" + "Subscription Customer" ], - "summary": "Partially update information about a Subscription resource.", + "summary": "Partially update information about a Subscription Customer resource.", "description": "", - "operationId": "updateSubscription", + "operationId": "updateSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -34059,18 +34045,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription resource.", + "description": "Partially update information about a Subscription Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -34082,7 +34068,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34097,7 +34083,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34116,14 +34102,14 @@ } } }, - "/aggregate/subscription": { + "/aggregate/subscription-customer": { "post": { "tags": [ - "Subscription" + "Subscription Customer" ], - "summary": "Aggregate for the Subscription resources.", + "summary": "Aggregate for the Subscription Customer resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscription", + "operationId": "aggregateSubscriptionCustomer", "requestBody": { "required": true, "content": { @@ -34147,7 +34133,7 @@ }, "responses": { "200": { - "description": "List of Subscription", + "description": "List of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -34161,7 +34147,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34179,7 +34165,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34196,14 +34182,14 @@ } } }, - "/subscription-address": { + "/subscription-interval": { "get": { "tags": [ - "Subscription Address" + "Subscription Interval" ], - "summary": "List with basic information of Subscription Address resources.", + "summary": "List with basic information of Subscription Interval resources.", "description": "", - "operationId": "getSubscriptionAddressList", + "operationId": "getSubscriptionIntervalList", "parameters": [ { "name": "limit", @@ -34232,7 +34218,7 @@ ], "responses": { "200": { - "description": "List of Subscription Address resources.", + "description": "List of Subscription Interval resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34251,7 +34237,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionInterval" } } ] @@ -34265,16 +34251,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-address?limit=25" + "example": "/subscription-interval?limit=25" }, "last": { - "example": "/subscription-address?limit=25&page=11" + "example": "/subscription-interval?limit=25&page=11" }, "next": { - "example": "/subscription-address?limit=25&page=4" + "example": "/subscription-interval?limit=25&page=4" }, "prev": { - "example": "/subscription-address?limit=25&page=2" + "example": "/subscription-interval?limit=25&page=2" } } } @@ -34295,7 +34281,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34310,11 +34296,11 @@ }, "post": { "tags": [ - "Subscription Address" + "Subscription Interval" ], - "summary": "Create a new Subscription Address resources.", + "summary": "Create a new Subscription Interval resources.", "description": "", - "operationId": "createSubscriptionAddress", + "operationId": "createSubscriptionInterval", "parameters": [ { "name": "_response", @@ -34333,14 +34319,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionInterval" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -34352,7 +34338,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34367,7 +34353,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34383,14 +34369,14 @@ } } }, - "/search/subscription-address": { + "/search/subscription-interval": { "post": { "tags": [ - "Subscription Address" + "Subscription Interval" ], - "summary": "Search for the Subscription Address resources.", + "summary": "Search for the Subscription Interval resources.", "description": "", - "operationId": "searchSubscriptionAddress", + "operationId": "searchSubscriptionInterval", "parameters": [ { "name": "sw-include-search-info", @@ -34418,7 +34404,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionAddress", + "description": "List of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -34432,7 +34418,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34450,7 +34436,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34467,19 +34453,19 @@ } } }, - "/subscription-address/{id}": { + "/subscription-interval/{id}": { "get": { "tags": [ - "Subscription Address" + "Subscription Interval" ], - "summary": "Detailed information about a Subscription Address resource.", + "summary": "Detailed information about a Subscription Interval resource.", "description": "", - "operationId": "getSubscriptionAddress", + "operationId": "getSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -34489,7 +34475,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -34501,7 +34487,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34516,7 +34502,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34533,16 +34519,16 @@ }, "delete": { "tags": [ - "Subscription Address" + "Subscription Interval" ], - "summary": "Delete a Subscription Address resource.", + "summary": "Delete a Subscription Interval resource.", "description": "", - "operationId": "deleteSubscriptionAddress", + "operationId": "deleteSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -34573,16 +34559,16 @@ }, "patch": { "tags": [ - "Subscription Address" + "Subscription Interval" ], - "summary": "Partially update information about a Subscription Address resource.", + "summary": "Partially update information about a Subscription Interval resource.", "description": "", - "operationId": "updateSubscriptionAddress", + "operationId": "updateSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -34600,18 +34586,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Address resource.", + "description": "Partially update information about a Subscription Interval resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionInterval" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -34623,7 +34609,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34638,7 +34624,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34657,14 +34643,14 @@ } } }, - "/aggregate/subscription-address": { + "/aggregate/subscription-interval": { "post": { "tags": [ - "Subscription Address" + "Subscription Interval" ], - "summary": "Aggregate for the Subscription Address resources.", + "summary": "Aggregate for the Subscription Interval resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscriptionAddress", + "operationId": "aggregateSubscriptionInterval", "requestBody": { "required": true, "content": { @@ -34688,7 +34674,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionAddress", + "description": "List of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -34702,7 +34688,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34720,7 +34706,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34737,14 +34723,14 @@ } } }, - "/subscription-customer": { + "/subscription-plan": { "get": { "tags": [ - "Subscription Customer" + "Subscription Plan" ], - "summary": "List with basic information of Subscription Customer resources.", + "summary": "List with basic information of Subscription Plan resources.", "description": "", - "operationId": "getSubscriptionCustomerList", + "operationId": "getSubscriptionPlanList", "parameters": [ { "name": "limit", @@ -34773,7 +34759,7 @@ ], "responses": { "200": { - "description": "List of Subscription Customer resources.", + "description": "List of Subscription Plan resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34792,7 +34778,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionPlan" } } ] @@ -34806,16 +34792,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-customer?limit=25" + "example": "/subscription-plan?limit=25" }, "last": { - "example": "/subscription-customer?limit=25&page=11" + "example": "/subscription-plan?limit=25&page=11" }, "next": { - "example": "/subscription-customer?limit=25&page=4" + "example": "/subscription-plan?limit=25&page=4" }, "prev": { - "example": "/subscription-customer?limit=25&page=2" + "example": "/subscription-plan?limit=25&page=2" } } } @@ -34836,7 +34822,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -34851,11 +34837,11 @@ }, "post": { "tags": [ - "Subscription Customer" + "Subscription Plan" ], - "summary": "Create a new Subscription Customer resources.", + "summary": "Create a new Subscription Plan resources.", "description": "", - "operationId": "createSubscriptionCustomer", + "operationId": "createSubscriptionPlan", "parameters": [ { "name": "_response", @@ -34874,14 +34860,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionPlan" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -34893,7 +34879,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -34908,7 +34894,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -34924,14 +34910,14 @@ } } }, - "/search/subscription-customer": { + "/search/subscription-plan": { "post": { "tags": [ - "Subscription Customer" + "Subscription Plan" ], - "summary": "Search for the Subscription Customer resources.", + "summary": "Search for the Subscription Plan resources.", "description": "", - "operationId": "searchSubscriptionCustomer", + "operationId": "searchSubscriptionPlan", "parameters": [ { "name": "sw-include-search-info", @@ -34959,7 +34945,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionCustomer", + "description": "List of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -34973,7 +34959,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -34991,7 +34977,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35008,19 +34994,19 @@ } } }, - "/subscription-customer/{id}": { + "/subscription-plan/{id}": { "get": { "tags": [ - "Subscription Customer" + "Subscription Plan" ], - "summary": "Detailed information about a Subscription Customer resource.", + "summary": "Detailed information about a Subscription Plan resource.", "description": "", - "operationId": "getSubscriptionCustomer", + "operationId": "getSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", @@ -35030,7 +35016,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -35042,7 +35028,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35057,7 +35043,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35074,16 +35060,16 @@ }, "delete": { "tags": [ - "Subscription Customer" + "Subscription Plan" ], - "summary": "Delete a Subscription Customer resource.", + "summary": "Delete a Subscription Plan resource.", "description": "", - "operationId": "deleteSubscriptionCustomer", + "operationId": "deleteSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", @@ -35114,16 +35100,16 @@ }, "patch": { "tags": [ - "Subscription Customer" + "Subscription Plan" ], - "summary": "Partially update information about a Subscription Customer resource.", + "summary": "Partially update information about a Subscription Plan resource.", "description": "", - "operationId": "updateSubscriptionCustomer", + "operationId": "updateSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", @@ -35141,18 +35127,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Customer resource.", + "description": "Partially update information about a Subscription Plan resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionPlan" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -35164,7 +35150,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35179,7 +35165,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35198,14 +35184,14 @@ } } }, - "/aggregate/subscription-customer": { + "/aggregate/subscription-plan": { "post": { "tags": [ - "Subscription Customer" + "Subscription Plan" ], - "summary": "Aggregate for the Subscription Customer resources.", + "summary": "Aggregate for the Subscription Plan resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscriptionCustomer", + "operationId": "aggregateSubscriptionPlan", "requestBody": { "required": true, "content": { @@ -35229,7 +35215,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionCustomer", + "description": "List of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -35243,7 +35229,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35261,7 +35247,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35278,14 +35264,14 @@ } } }, - "/subscription-interval": { + "/swag-delay-action": { "get": { "tags": [ - "Subscription Interval" + "Swag Delay Action" ], - "summary": "List with basic information of Subscription Interval resources.", + "summary": "List with basic information of Swag Delay Action resources.", "description": "", - "operationId": "getSubscriptionIntervalList", + "operationId": "getSwagDelayActionList", "parameters": [ { "name": "limit", @@ -35314,7 +35300,7 @@ ], "responses": { "200": { - "description": "List of Subscription Interval resources.", + "description": "List of Swag Delay Action resources.", "content": { "application/vnd.api+json": { "schema": { @@ -35333,7 +35319,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SwagDelayAction" } } ] @@ -35347,16 +35333,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-interval?limit=25" + "example": "/swag-delay-action?limit=25" }, "last": { - "example": "/subscription-interval?limit=25&page=11" + "example": "/swag-delay-action?limit=25&page=11" }, "next": { - "example": "/subscription-interval?limit=25&page=4" + "example": "/swag-delay-action?limit=25&page=4" }, "prev": { - "example": "/subscription-interval?limit=25&page=2" + "example": "/swag-delay-action?limit=25&page=2" } } } @@ -35377,7 +35363,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35392,11 +35378,11 @@ }, "post": { "tags": [ - "Subscription Interval" + "Swag Delay Action" ], - "summary": "Create a new Subscription Interval resources.", + "summary": "Create a new Swag Delay Action resources.", "description": "", - "operationId": "createSubscriptionInterval", + "operationId": "createSwagDelayAction", "parameters": [ { "name": "_response", @@ -35415,14 +35401,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SwagDelayAction" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -35434,7 +35420,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35449,7 +35435,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35465,14 +35451,14 @@ } } }, - "/search/subscription-interval": { + "/search/swag-delay-action": { "post": { "tags": [ - "Subscription Interval" + "Swag Delay Action" ], - "summary": "Search for the Subscription Interval resources.", + "summary": "Search for the Swag Delay Action resources.", "description": "", - "operationId": "searchSubscriptionInterval", + "operationId": "searchSwagDelayAction", "parameters": [ { "name": "sw-include-search-info", @@ -35500,7 +35486,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionInterval", + "description": "List of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -35514,7 +35500,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35532,7 +35518,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35549,19 +35535,19 @@ } } }, - "/subscription-interval/{id}": { + "/swag-delay-action/{id}": { "get": { "tags": [ - "Subscription Interval" + "Swag Delay Action" ], - "summary": "Detailed information about a Subscription Interval resource.", + "summary": "Detailed information about a Swag Delay Action resource.", "description": "", - "operationId": "getSubscriptionInterval", + "operationId": "getSwagDelayAction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the swag_delay_action", "required": true, "schema": { "type": "string", @@ -35571,7 +35557,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -35583,7 +35569,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35598,7 +35584,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35615,16 +35601,16 @@ }, "delete": { "tags": [ - "Subscription Interval" + "Swag Delay Action" ], - "summary": "Delete a Subscription Interval resource.", + "summary": "Delete a Swag Delay Action resource.", "description": "", - "operationId": "deleteSubscriptionInterval", + "operationId": "deleteSwagDelayAction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the swag_delay_action", "required": true, "schema": { "type": "string", @@ -35655,16 +35641,16 @@ }, "patch": { "tags": [ - "Subscription Interval" + "Swag Delay Action" ], - "summary": "Partially update information about a Subscription Interval resource.", + "summary": "Partially update information about a Swag Delay Action resource.", "description": "", - "operationId": "updateSubscriptionInterval", + "operationId": "updateSwagDelayAction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the swag_delay_action", "required": true, "schema": { "type": "string", @@ -35682,18 +35668,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Interval resource.", + "description": "Partially update information about a Swag Delay Action resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SwagDelayAction" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -35705,7 +35691,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35720,7 +35706,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35739,14 +35725,14 @@ } } }, - "/aggregate/subscription-interval": { + "/aggregate/swag-delay-action": { "post": { "tags": [ - "Subscription Interval" + "Swag Delay Action" ], - "summary": "Aggregate for the Subscription Interval resources.", + "summary": "Aggregate for the Swag Delay Action resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscriptionInterval", + "operationId": "aggregateSwagDelayAction", "requestBody": { "required": true, "content": { @@ -35770,548 +35756,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionInterval", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SubscriptionInterval" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SubscriptionInterval" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/subscription-plan": { - "get": { - "tags": [ - "Subscription Plan" - ], - "summary": "List with basic information of Subscription Plan resources.", - "description": "", - "operationId": "getSubscriptionPlanList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Subscription Plan 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/SubscriptionPlan" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/subscription-plan?limit=25" - }, - "last": { - "example": "/subscription-plan?limit=25&page=11" - }, - "next": { - "example": "/subscription-plan?limit=25&page=4" - }, - "prev": { - "example": "/subscription-plan?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SubscriptionPlan" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Subscription Plan" - ], - "summary": "Create a new Subscription Plan resources.", - "description": "", - "operationId": "createSubscriptionPlan", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SubscriptionPlan", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionPlan" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionPlan" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/subscription-plan": { - "post": { - "tags": [ - "Subscription Plan" - ], - "summary": "Search for the Subscription Plan resources.", - "description": "", - "operationId": "searchSubscriptionPlan", - "parameters": [ - { - "name": "sw-include-search-info", - "in": "header", - "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", - "schema": { - "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of SubscriptionPlan", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SubscriptionPlan" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SubscriptionPlan" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/subscription-plan/{id}": { - "get": { - "tags": [ - "Subscription Plan" - ], - "summary": "Detailed information about a Subscription Plan resource.", - "description": "", - "operationId": "getSubscriptionPlan", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the subscription_plan", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SubscriptionPlan", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionPlan" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionPlan" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Subscription Plan" - ], - "summary": "Delete a Subscription Plan resource.", - "description": "", - "operationId": "deleteSubscriptionPlan", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the subscription_plan", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Subscription Plan" - ], - "summary": "Partially update information about a Subscription Plan resource.", - "description": "", - "operationId": "updateSubscriptionPlan", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the subscription_plan", - "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 Subscription Plan resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SubscriptionPlan", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionPlan" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionPlan" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/subscription-plan": { - "post": { - "tags": [ - "Subscription Plan" - ], - "summary": "Aggregate for the Subscription Plan resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscriptionPlan", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SubscriptionPlan", + "description": "List of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -36325,7 +35770,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -36343,7 +35788,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -36360,14 +35805,14 @@ } } }, - "/swag-delay-action": { + "/warehouse": { "get": { "tags": [ - "Swag Delay Action" + "Warehouse" ], - "summary": "List with basic information of Swag Delay Action resources.", + "summary": "List with basic information of Warehouse resources.", "description": "", - "operationId": "getSwagDelayActionList", + "operationId": "getWarehouseList", "parameters": [ { "name": "limit", @@ -36396,7 +35841,7 @@ ], "responses": { "200": { - "description": "List of Swag Delay Action resources.", + "description": "List of Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { @@ -36415,7 +35860,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } ] @@ -36429,16 +35874,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-delay-action?limit=25" + "example": "/warehouse?limit=25" }, "last": { - "example": "/swag-delay-action?limit=25&page=11" + "example": "/warehouse?limit=25&page=11" }, "next": { - "example": "/swag-delay-action?limit=25&page=4" + "example": "/warehouse?limit=25&page=4" }, "prev": { - "example": "/swag-delay-action?limit=25&page=2" + "example": "/warehouse?limit=25&page=2" } } } @@ -36459,7 +35904,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36474,11 +35919,11 @@ }, "post": { "tags": [ - "Swag Delay Action" + "Warehouse" ], - "summary": "Create a new Swag Delay Action resources.", + "summary": "Create a new Warehouse resources.", "description": "", - "operationId": "createSwagDelayAction", + "operationId": "createWarehouse", "parameters": [ { "name": "_response", @@ -36497,14 +35942,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of Warehouse", "content": { "application/vnd.api+json": { "schema": { @@ -36516,7 +35961,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36531,7 +35976,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36547,14 +35992,14 @@ } } }, - "/search/swag-delay-action": { + "/search/warehouse": { "post": { "tags": [ - "Swag Delay Action" + "Warehouse" ], - "summary": "Search for the Swag Delay Action resources.", + "summary": "Search for the Warehouse resources.", "description": "", - "operationId": "searchSwagDelayAction", + "operationId": "searchWarehouse", "parameters": [ { "name": "sw-include-search-info", @@ -36582,7 +36027,7 @@ }, "responses": { "200": { - "description": "List of SwagDelayAction", + "description": "List of Warehouse", "content": { "application/vnd.api+json": { "schema": { @@ -36596,7 +36041,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36614,7 +36059,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36631,19 +36076,19 @@ } } }, - "/swag-delay-action/{id}": { + "/warehouse/{id}": { "get": { "tags": [ - "Swag Delay Action" + "Warehouse" ], - "summary": "Detailed information about a Swag Delay Action resource.", + "summary": "Detailed information about a Warehouse resource.", "description": "", - "operationId": "getSwagDelayAction", + "operationId": "getWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the warehouse", "required": true, "schema": { "type": "string", @@ -36653,7 +36098,7 @@ ], "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of Warehouse", "content": { "application/vnd.api+json": { "schema": { @@ -36665,7 +36110,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36680,7 +36125,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36697,16 +36142,16 @@ }, "delete": { "tags": [ - "Swag Delay Action" + "Warehouse" ], - "summary": "Delete a Swag Delay Action resource.", + "summary": "Delete a Warehouse resource.", "description": "", - "operationId": "deleteSwagDelayAction", + "operationId": "deleteWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the warehouse", "required": true, "schema": { "type": "string", @@ -36737,16 +36182,16 @@ }, "patch": { "tags": [ - "Swag Delay Action" + "Warehouse" ], - "summary": "Partially update information about a Swag Delay Action resource.", + "summary": "Partially update information about a Warehouse resource.", "description": "", - "operationId": "updateSwagDelayAction", + "operationId": "updateWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the warehouse", "required": true, "schema": { "type": "string", @@ -36764,18 +36209,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Delay Action resource.", + "description": "Partially update information about a Warehouse resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of Warehouse", "content": { "application/vnd.api+json": { "schema": { @@ -36787,7 +36232,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36802,7 +36247,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36821,14 +36266,14 @@ } } }, - "/aggregate/swag-delay-action": { + "/aggregate/warehouse": { "post": { "tags": [ - "Swag Delay Action" + "Warehouse" ], - "summary": "Aggregate for the Swag Delay Action resources.", + "summary": "Aggregate for the Warehouse resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagDelayAction", + "operationId": "aggregateWarehouse", "requestBody": { "required": true, "content": { @@ -36852,7 +36297,7 @@ }, "responses": { "200": { - "description": "List of SwagDelayAction", + "description": "List of Warehouse", "content": { "application/vnd.api+json": { "schema": { @@ -36866,7 +36311,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36884,7 +36329,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36901,14 +36346,14 @@ } } }, - "/warehouse": { + "/warehouse-group": { "get": { "tags": [ - "Warehouse" + "Warehouse Group" ], - "summary": "List with basic information of Warehouse resources.", + "summary": "List with basic information of Warehouse Group resources.", "description": "", - "operationId": "getWarehouseList", + "operationId": "getWarehouseGroupList", "parameters": [ { "name": "limit", @@ -36937,7 +36382,7 @@ ], "responses": { "200": { - "description": "List of Warehouse resources.", + "description": "List of Warehouse Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -36956,7 +36401,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } ] @@ -36970,16 +36415,16 @@ "type": "object", "properties": { "first": { - "example": "/warehouse?limit=25" + "example": "/warehouse-group?limit=25" }, "last": { - "example": "/warehouse?limit=25&page=11" + "example": "/warehouse-group?limit=25&page=11" }, "next": { - "example": "/warehouse?limit=25&page=4" + "example": "/warehouse-group?limit=25&page=4" }, "prev": { - "example": "/warehouse?limit=25&page=2" + "example": "/warehouse-group?limit=25&page=2" } } } @@ -37000,7 +36445,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37015,11 +36460,11 @@ }, "post": { "tags": [ - "Warehouse" + "Warehouse Group" ], - "summary": "Create a new Warehouse resources.", + "summary": "Create a new Warehouse Group resources.", "description": "", - "operationId": "createWarehouse", + "operationId": "createWarehouseGroup", "parameters": [ { "name": "_response", @@ -37038,14 +36483,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } }, "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of WarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -37057,7 +36502,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37072,7 +36517,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37088,14 +36533,14 @@ } } }, - "/search/warehouse": { + "/search/warehouse-group": { "post": { "tags": [ - "Warehouse" + "Warehouse Group" ], - "summary": "Search for the Warehouse resources.", + "summary": "Search for the Warehouse Group resources.", "description": "", - "operationId": "searchWarehouse", + "operationId": "searchWarehouseGroup", "parameters": [ { "name": "sw-include-search-info", @@ -37123,7 +36568,7 @@ }, "responses": { "200": { - "description": "List of Warehouse", + "description": "List of WarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -37137,7 +36582,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37155,7 +36600,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37172,19 +36617,19 @@ } } }, - "/warehouse/{id}": { + "/warehouse-group/{id}": { "get": { "tags": [ - "Warehouse" + "Warehouse Group" ], - "summary": "Detailed information about a Warehouse resource.", + "summary": "Detailed information about a Warehouse Group resource.", "description": "", - "operationId": "getWarehouse", + "operationId": "getWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the warehouse_group", "required": true, "schema": { "type": "string", @@ -37194,7 +36639,7 @@ ], "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of WarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -37206,7 +36651,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37221,7 +36666,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37238,16 +36683,16 @@ }, "delete": { "tags": [ - "Warehouse" + "Warehouse Group" ], - "summary": "Delete a Warehouse resource.", + "summary": "Delete a Warehouse Group resource.", "description": "", - "operationId": "deleteWarehouse", + "operationId": "deleteWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the warehouse_group", "required": true, "schema": { "type": "string", @@ -37278,16 +36723,16 @@ }, "patch": { "tags": [ - "Warehouse" + "Warehouse Group" ], - "summary": "Partially update information about a Warehouse resource.", + "summary": "Partially update information about a Warehouse Group resource.", "description": "", - "operationId": "updateWarehouse", + "operationId": "updateWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the warehouse_group", "required": true, "schema": { "type": "string", @@ -37305,18 +36750,18 @@ } ], "requestBody": { - "description": "Partially update information about a Warehouse resource.", + "description": "Partially update information about a Warehouse Group resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } }, "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of WarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -37328,7 +36773,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37343,7 +36788,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37362,14 +36807,14 @@ } } }, - "/aggregate/warehouse": { + "/aggregate/warehouse-group": { "post": { "tags": [ - "Warehouse" + "Warehouse Group" ], - "summary": "Aggregate for the Warehouse resources.", + "summary": "Aggregate for the Warehouse Group resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateWarehouse", + "operationId": "aggregateWarehouseGroup", "requestBody": { "required": true, "content": { @@ -37391,277 +36836,6 @@ } } }, - "responses": { - "200": { - "description": "List of Warehouse", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Warehouse" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Warehouse" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/warehouse-group": { - "get": { - "tags": [ - "Warehouse Group" - ], - "summary": "List with basic information of Warehouse Group resources.", - "description": "", - "operationId": "getWarehouseGroupList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Warehouse Group 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/WarehouseGroup" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/warehouse-group?limit=25" - }, - "last": { - "example": "/warehouse-group?limit=25&page=11" - }, - "next": { - "example": "/warehouse-group?limit=25&page=4" - }, - "prev": { - "example": "/warehouse-group?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WarehouseGroup" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Warehouse Group" - ], - "summary": "Create a new Warehouse Group resources.", - "description": "", - "operationId": "createWarehouseGroup", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WarehouseGroup" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of WarehouseGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WarehouseGroup" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/WarehouseGroup" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/warehouse-group": { - "post": { - "tags": [ - "Warehouse Group" - ], - "summary": "Search for the Warehouse Group resources.", - "description": "", - "operationId": "searchWarehouseGroup", - "parameters": [ - { - "name": "sw-include-search-info", - "in": "header", - "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", - "schema": { - "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, "responses": { "200": { "description": "List of WarehouseGroup", @@ -37713,93 +36887,116 @@ } } }, - "/warehouse-group/{id}": { - "get": { + "/_action/validation/email": { + "post": { "tags": [ - "Warehouse Group" + "Email support validation" ], - "summary": "Detailed information about a Warehouse Group resource.", - "description": "", - "operationId": "getWarehouseGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the warehouse_group", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Email support.", + "description": "Checks a given email string.", + "operationId": "supportsEmail", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "email" + ], + "properties": { + "email": { + "description": "The email to be verified.", + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { - "200": { - "description": "Detail of WarehouseGroup", + "204": { + "description": "Email is supported" + }, + "400": { + "description": "Invalid request payload. The argument 'email' may be missing.", "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, + "properties": { + "errors": { + "description": "Contains the error message.", + "type": "array" + } + }, + "type": "object" + }, + "example": { + "errors": [ { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WarehouseGroup" - } - } + "code": "0", + "status": "400", + "title": "Unprocessable Content", + "detail": "This value should not be blank." } ] } - }, + } + } + }, + "422": { + "description": "Email address is not supported.", + "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], "properties": { - "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "errors": { + "description": "Contains the validation error.", + "type": "array" } - } + }, + "type": "object" + }, + "example": { + "errors": [ + { + "code": "0", + "status": "422", + "title": "Unprocessable Content", + "detail": "This value is not a supported email address." + } + ] } } } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } - }, - "delete": { + } + }, + "/app-system/shop/verify": { + "get": { "tags": [ - "Warehouse Group" + "App System", + "Public" ], - "summary": "Delete a Warehouse Group resource.", - "description": "", - "operationId": "deleteWarehouseGroup", + "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", "parameters": [ { - "name": "id", - "in": "path", - "description": "Identifier for the warehouse_group", + "name": "runId", + "in": "query", + "description": "A unique identifier used to look up the token", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } }, { - "name": "_response", + "name": "token", "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, + "description": "A unique identifier", + "required": true, "schema": { "type": "string" } @@ -37807,110 +37004,213 @@ ], "responses": { "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "description": "An empty response signalling successful verification." }, - "401": { - "$ref": "#/components/responses/401" + "400": { + "description": "Malformed request or unsuccessful verification." } } - }, - "patch": { + } + }, + "/_action/system-config": { + "get": { "tags": [ - "Warehouse Group" + "System Config" ], - "summary": "Partially update information about a Warehouse Group resource.", - "description": "", - "operationId": "updateWarehouseGroup", + "summary": "Get configuration values", + "description": "Returns the configuration values for the given domain and optional sales channel.", + "operationId": "getConfigurationValues", "parameters": [ { - "name": "id", - "in": "path", - "description": "Identifier for the warehouse_group", + "name": "domain", + "in": "query", + "description": "The configuration domain.", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } }, { - "name": "_response", + "name": "salesChannelId", "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, + "description": "The sales channel ID to scope the configuration to.", "schema": { "type": "string" } + }, + { + "name": "inherit", + "in": "query", + "description": "Whether to include inherited (global) values.", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Returns the configuration values as a key-value object." + } + } + }, + "post": { + "tags": [ + "System Config" + ], + "summary": "Save configuration values", + "description": "Saves the given configuration key-value pairs for the given sales channel.", + "operationId": "saveConfiguration", + "parameters": [ + { + "name": "salesChannelId", + "in": "query", + "description": "The sales channel ID to scope the configuration to.", + "schema": { + "type": "string" + } + }, + { + "name": "silent", + "in": "query", + "description": "If true, the HTTP cache will not be invalidated. Use this for internal configuration values that do not affect the storefront.", + "schema": { + "type": "boolean", + "default": false + } } ], "requestBody": { - "description": "Partially update information about a Warehouse Group resource.", + "description": "Key-value pairs of configuration values to save.", + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "type": "object", + "additionalProperties": true } } } }, + "responses": { + "204": { + "description": "Configuration saved successfully." + } + } + } + }, + "/_action/system-config/check": { + "get": { + "tags": [ + "System Config" + ], + "summary": "Check configuration", + "description": "Checks if a configuration domain exists.", + "operationId": "checkConfiguration", + "parameters": [ + { + "name": "domain", + "in": "query", + "description": "The configuration domain to check.", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { - "description": "Detail of WarehouseGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WarehouseGroup" - } - } - } - ] - } - }, - "application/json": { - "schema": { + "description": "Returns whether the configuration domain exists." + } + } + } + }, + "/_action/system-config/schema": { + "get": { + "tags": [ + "System Config" + ], + "summary": "Get configuration schema", + "description": "Returns the configuration schema for the given domain.", + "operationId": "getConfiguration", + "parameters": [ + { + "name": "domain", + "in": "query", + "description": "The configuration domain.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns the configuration schema." + } + } + } + }, + "/_action/system-config/batch": { + "post": { + "tags": [ + "System Config" + ], + "summary": "Batch save configuration values", + "description": "Saves configuration values for multiple sales channels at once. The request body is keyed by sales channel ID (use \"null\" for global scope).", + "operationId": "batchSaveConfiguration", + "parameters": [ + { + "name": "silent", + "in": "query", + "description": "If true, the HTTP cache will not be invalidated. Use this for internal configuration values that do not affect the storefront.", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "requestBody": { + "description": "Object keyed by sales channel ID, each containing key-value pairs of configuration values.", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/WarehouseGroup" - } - } + "additionalProperties": true } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" + } + }, + "responses": { + "204": { + "description": "Configuration saved successfully." } } } }, - "/aggregate/warehouse-group": { + "/_action/media/{mediaId}/external-thumbnails": { "post": { "tags": [ - "Warehouse Group" + "Asset Management" + ], + "summary": "Add external thumbnails to media", + "description": "Attaches external thumbnail URLs to an existing external media entity. The media must have an HTTP/HTTPS path (i.e. be an external media link).\n\nUsed for CDNs that pre-generated thumbnails alongside the main media file.\nNot to be confused with [remote thumbnails](https://developer.shopware.com/docs/guides/plugins/plugins/content/media/remote-thumbnail-generation.html#remote-thumbnail-generation), which are generated based on a pattern.\n\nThe thumbnail sized are matched against existing thumbnails sizes and a matching size will automatically be assigned. If there's not existing size, a **new thumbnail size will automatically be created** for each missing size.", + "operationId": "addExternalThumbnails", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "description": "ID of the external media entity the thumbnails will be attached to.", + "required": true, + "schema": { + "$ref": "#/components/schemas/MediaId" + } + } ], - "summary": "Aggregate for the Warehouse Group resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateWarehouseGroup", "requestBody": { "required": true, "content": { @@ -37918,56 +37218,75 @@ "schema": { "type": "object", "properties": { - "aggregations": { + "thumbnails": { "type": "array", + "description": "List of external thumbnails to attach", "items": { - "$ref": "#/components/schemas/Aggregation" + "$ref": "#/components/schemas/ExternalThumbnail" } } - }, - "required": [ - "aggregations" - ] + } } } } }, "responses": { - "200": { - "description": "List of WarehouseGroup", + "201": { + "description": "Thumbnails attached successfully", "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" + "type": "object", + "properties": { + "mediaId": { + "description": "ID of the media entity the thumbnails were attached to.", + "$ref": "#/components/schemas/MediaId" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WarehouseGroup" - } - } - } + "thumbnailsCreated": { + "type": "integer" } - ] + } } - }, + } + } + }, + "400": { + "description": "Media is not an external media entity or path is missing" + }, + "404": { + "description": "Media entity not found" + } + } + }, + "delete": { + "tags": [ + "Asset Management" + ], + "summary": "Delete all external thumbnails from media", + "description": "Removes all externally stored thumbnail entries from the given media entity. Only works on external media (media with an HTTP/HTTPS path). Used to replace outdated thumbnails with new ones.", + "operationId": "deleteExternalThumbnails", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "description": "ID of the external media entity the thumbnails will be deleted from..", + "required": true, + "schema": { + "$ref": "#/components/schemas/MediaId" + } + } + ], + "responses": { + "200": { + "description": "Thumbnails deleted successfully", + "content": { "application/json": { "schema": { "type": "object", "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WarehouseGroup" - } + "mediaId": { + "description": "ID of the media entity the thumbnails were deleted from.", + "$ref": "#/components/schemas/MediaId" } } } @@ -37975,10 +37294,31 @@ } }, "400": { - "$ref": "#/components/responses/400" + "description": "Media is not an external media entity or path is missing" + }, + "404": { + "description": "Media entity not found" + } + } + } + }, + "/_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": { - "$ref": "#/components/responses/401" + "description": "Unauthorized - the access token is missing or invalid." + }, + "403": { + "description": "The authenticated source does not have a user ID associated." } } } @@ -50967,11 +50307,6 @@ "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": { @@ -51208,12 +50543,6 @@ "additionalProperties": false } }, - "ogTitle": { - "type": "string" - }, - "ogDescription": { - "type": "string" - }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -52031,36 +51360,6 @@ }, "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": { @@ -52842,11 +52141,6 @@ "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": { @@ -53083,12 +52377,6 @@ "additionalProperties": false } }, - "ogTitle": { - "type": "string" - }, - "ogDescription": { - "type": "string" - }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -53698,10 +52986,6 @@ "$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" }, @@ -59926,35 +59210,6 @@ }, "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" - }, "customPrice": { "properties": { "links": { @@ -61289,35 +60544,6 @@ }, "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" - }, "customPrice": { "properties": { "links": { @@ -68262,9 +67488,6 @@ "systemDefault": { "type": "boolean" }, - "wasModifiedByUser": { - "type": "boolean" - }, "senderName": { "type": "string" }, @@ -68387,9 +67610,6 @@ "systemDefault": { "type": "boolean" }, - "wasModifiedByUser": { - "type": "boolean" - }, "senderName": { "type": "string" }, @@ -69912,37 +69132,6 @@ }, "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": { @@ -70605,12 +69794,6 @@ "$ref": "#/components/schemas/ProductConfiguratorSetting" } }, - "productOpenGraphImages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, "orderLineItems": { "type": "array", "items": { @@ -73353,35 +72536,6 @@ }, "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" - }, "subscription": { "properties": { "links": { @@ -74531,35 +73685,6 @@ }, "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" - }, "subscription": { "properties": { "links": { @@ -82318,10 +81443,6 @@ "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" @@ -82587,10 +81708,6 @@ "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" @@ -85493,12 +84610,7 @@ "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", - "enum": [ - 10, - 20, - 30 - ] + "format": "int64" }, "createdAt": { "type": "string", @@ -85608,12 +84720,7 @@ "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", - "enum": [ - 10, - 20, - 30 - ] + "format": "int64" }, "createdAt": { "type": "string", @@ -92801,68 +91908,6 @@ }, "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": { @@ -94479,68 +93524,6 @@ }, "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": { @@ -95626,298 +94609,6 @@ }, "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": [ @@ -109458,20 +108149,6 @@ ], "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." } } }, @@ -112251,14 +110928,6 @@ "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/SwagCommercial-adminapi.summary.json b/SwagCommercial-adminapi.summary.json index 7228d8d..fefe801 100644 --- a/SwagCommercial-adminapi.summary.json +++ b/SwagCommercial-adminapi.summary.json @@ -3,14 +3,21 @@ "/_action/create-employee", "/_action/custom-price", "/_action/invite-employee", + "/_action/media/{mediaId}/external-thumbnails", "/_action/quote/{quoteId}/comment", "/_action/quote/{quoteId}/lineItem", "/_action/quote/{quoteId}/product/{productId}", "/_action/quote/{quoteId}/recalculate", "/_action/share-config/download/{entity}/{id}", "/_action/share-config/upload/{entity}", + "/_action/system-config", + "/_action/system-config/batch", + "/_action/system-config/check", + "/_action/system-config/schema", "/_action/text-to-image/generate", "/_action/update-employee", + "/_action/user/logout", + "/_action/validation/email", "/_proxy-quote/{salesChannelId}", "/advanced-search-action", "/advanced-search-action-search-term", @@ -78,8 +85,6 @@ "/aggregate/quote-employee", "/aggregate/quote-line-item", "/aggregate/quote-transaction", - "/aggregate/sales-channel-tracking-customer", - "/aggregate/sales-channel-tracking-order", "/aggregate/spatial-render-config-size", "/aggregate/spatial-scene", "/aggregate/spatial-scene-camera", @@ -100,6 +105,7 @@ "/aggregate/warehouse-group", "/api/_action/generate-review-summary", "/api/_admin/rule-builder-preview/{orderId}", + "/app-system/shop/verify", "/b2b-business-partner", "/b2b-business-partner/{id}", "/b2b-components-advanced-product-catalogs", @@ -189,10 +195,6 @@ "/quote-transaction", "/quote-transaction/{id}", "/quote/{id}", - "/sales-channel-tracking-customer", - "/sales-channel-tracking-customer/{id}", - "/sales-channel-tracking-order", - "/sales-channel-tracking-order/{id}", "/search/advanced-search-action", "/search/advanced-search-action-search-term", "/search/advanced-search-boosting", @@ -243,8 +245,6 @@ "/search/quote-employee", "/search/quote-line-item", "/search/quote-transaction", - "/search/sales-channel-tracking-customer", - "/search/sales-channel-tracking-order", "/search/spatial-render-config-size", "/search/spatial-scene", "/search/spatial-scene-camera", @@ -695,10 +695,6 @@ "SalesChannelLanguage", "SalesChannelPaymentMethod", "SalesChannelShippingMethod", - "SalesChannelTrackingCustomer", - "SalesChannelTrackingCustomerJsonApi", - "SalesChannelTrackingOrder", - "SalesChannelTrackingOrderJsonApi", "SalesChannelType", "SalesChannelTypeJsonApi", "Salutation", diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index 6287809..a2fb2b4 100644 --- a/SwagCustomizedProducts-adminapi.json +++ b/SwagCustomizedProducts-adminapi.json @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.7.9999999-dev" + "version": "6.7.9.0" }, "servers": [ { @@ -15,15 +15,14 @@ } ], "paths": { - "/sales-channel-tracking-customer": { + "/swag-customized-products-template": { "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Swag Customized Products Template" ], - "summary": "List with basic information of Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingCustomerList", + "summary": "List with basic information of Swag Customized Products Template resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateList", "parameters": [ { "name": "limit", @@ -52,7 +51,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Tracking Customer resources.", + "description": "List of Swag Customized Products Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -71,7 +70,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } ] @@ -85,16 +84,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-tracking-customer?limit=25" + "example": "/swag-customized-products-template?limit=25" }, "last": { - "example": "/sales-channel-tracking-customer?limit=25&page=11" + "example": "/swag-customized-products-template?limit=25&page=11" }, "next": { - "example": "/sales-channel-tracking-customer?limit=25&page=4" + "example": "/swag-customized-products-template?limit=25&page=4" }, "prev": { - "example": "/sales-channel-tracking-customer?limit=25&page=2" + "example": "/swag-customized-products-template?limit=25&page=2" } } } @@ -115,7 +114,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -130,12 +129,11 @@ }, "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Swag Customized Products Template" ], - "summary": "Create a new Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "createSalesChannelTrackingCustomer", + "summary": "Create a new Swag Customized Products Template resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplate", "parameters": [ { "name": "_response", @@ -154,14 +152,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -173,7 +171,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -188,7 +186,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -204,15 +202,14 @@ } } }, - "/search/sales-channel-tracking-customer": { + "/search/swag-customized-products-template": { "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Swag Customized Products Template" ], - "summary": "Search for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "searchSalesChannelTrackingCustomer", + "summary": "Search for the Swag Customized Products Template resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplate", "parameters": [ { "name": "sw-include-search-info", @@ -240,7 +237,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingCustomer", + "description": "List of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -254,7 +251,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -272,7 +269,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -289,20 +286,19 @@ } } }, - "/sales-channel-tracking-customer/{id}": { + "/swag-customized-products-template/{id}": { "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Swag Customized Products Template" ], - "summary": "Detailed information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingCustomer", + "summary": "Detailed information about a Swag Customized Products Template resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", @@ -312,7 +308,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -324,7 +320,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -339,7 +335,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -356,17 +352,16 @@ }, "delete": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Swag Customized Products Template" ], - "summary": "Delete a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "deleteSalesChannelTrackingCustomer", + "summary": "Delete a Swag Customized Products Template resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", @@ -397,17 +392,16 @@ }, "patch": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Swag Customized Products Template" ], - "summary": "Partially update information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "updateSalesChannelTrackingCustomer", + "summary": "Partially update information about a Swag Customized Products Template resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", @@ -425,18 +419,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Tracking Customer resource.", + "description": "Partially update information about a Swag Customized Products Template resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -448,7 +442,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -463,7 +457,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -482,15 +476,14 @@ } } }, - "/aggregate/sales-channel-tracking-customer": { + "/aggregate/swag-customized-products-template": { "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Swag Customized Products Template" ], - "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", + "summary": "Aggregate for the Swag Customized Products Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplate", "requestBody": { "required": true, "content": { @@ -514,7 +507,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingCustomer", + "description": "List of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -528,7 +521,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -546,7 +539,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -563,15 +556,14 @@ } } }, - "/sales-channel-tracking-order": { + "/swag-customized-products-template-configuration": { "get": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Swag Customized Products Template Configuration" ], - "summary": "List with basic information of Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingOrderList", + "summary": "List with basic information of Swag Customized Products Template Configuration resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateConfigurationList", "parameters": [ { "name": "limit", @@ -600,7 +592,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Tracking Order resources.", + "description": "List of Swag Customized Products Template Configuration resources.", "content": { "application/vnd.api+json": { "schema": { @@ -619,7 +611,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } ] @@ -633,16 +625,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-tracking-order?limit=25" + "example": "/swag-customized-products-template-configuration?limit=25" }, "last": { - "example": "/sales-channel-tracking-order?limit=25&page=11" + "example": "/swag-customized-products-template-configuration?limit=25&page=11" }, "next": { - "example": "/sales-channel-tracking-order?limit=25&page=4" + "example": "/swag-customized-products-template-configuration?limit=25&page=4" }, "prev": { - "example": "/sales-channel-tracking-order?limit=25&page=2" + "example": "/swag-customized-products-template-configuration?limit=25&page=2" } } } @@ -663,7 +655,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -678,12 +670,11 @@ }, "post": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Swag Customized Products Template Configuration" ], - "summary": "Create a new Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "createSalesChannelTrackingOrder", + "summary": "Create a new Swag Customized Products Template Configuration resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "_response", @@ -702,14 +693,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -721,7 +712,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -736,7 +727,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -752,15 +743,14 @@ } } }, - "/search/sales-channel-tracking-order": { + "/search/swag-customized-products-template-configuration": { "post": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Swag Customized Products Template Configuration" ], - "summary": "Search for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "searchSalesChannelTrackingOrder", + "summary": "Search for the Swag Customized Products Template Configuration resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "sw-include-search-info", @@ -788,7 +778,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingOrder", + "description": "List of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -802,7 +792,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -820,7 +810,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -837,20 +827,19 @@ } } }, - "/sales-channel-tracking-order/{id}": { + "/swag-customized-products-template-configuration/{id}": { "get": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Swag Customized Products Template Configuration" ], - "summary": "Detailed information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingOrder", + "summary": "Detailed information about a Swag Customized Products Template Configuration resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", @@ -860,7 +849,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -872,7 +861,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -887,7 +876,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -904,17 +893,16 @@ }, "delete": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Swag Customized Products Template Configuration" ], - "summary": "Delete a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "deleteSalesChannelTrackingOrder", + "summary": "Delete a Swag Customized Products Template Configuration resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", @@ -945,17 +933,16 @@ }, "patch": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Swag Customized Products Template Configuration" ], - "summary": "Partially update information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "updateSalesChannelTrackingOrder", + "summary": "Partially update information about a Swag Customized Products Template Configuration resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", @@ -973,18 +960,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Tracking Order resource.", + "description": "Partially update information about a Swag Customized Products Template Configuration resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -996,7 +983,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1011,7 +998,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1030,15 +1017,14 @@ } } }, - "/aggregate/sales-channel-tracking-order": { + "/aggregate/swag-customized-products-template-configuration": { "post": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Swag Customized Products Template Configuration" ], - "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", + "summary": "Aggregate for the Swag Customized Products Template Configuration resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateConfiguration", "requestBody": { "required": true, "content": { @@ -1062,7 +1048,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingOrder", + "description": "List of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -1076,7 +1062,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1094,7 +1080,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -1111,14 +1097,14 @@ } } }, - "/swag-customized-products-template": { + "/swag-customized-products-template-configuration-share": { "get": { "tags": [ - "Swag Customized Products Template" + "Swag Customized Products Template Configuration Share" ], - "summary": "List with basic information of Swag Customized Products Template resources.", + "summary": "List with basic information of Swag Customized Products Template Configuration Share resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateList", + "operationId": "getSwagCustomizedProductsTemplateConfigurationShareList", "parameters": [ { "name": "limit", @@ -1147,7 +1133,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template resources.", + "description": "List of Swag Customized Products Template Configuration Share resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1166,7 +1152,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } ] @@ -1180,16 +1166,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template?limit=25" + "example": "/swag-customized-products-template-configuration-share?limit=25" }, "last": { - "example": "/swag-customized-products-template?limit=25&page=11" + "example": "/swag-customized-products-template-configuration-share?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template?limit=25&page=4" + "example": "/swag-customized-products-template-configuration-share?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template?limit=25&page=2" + "example": "/swag-customized-products-template-configuration-share?limit=25&page=2" } } } @@ -1210,7 +1196,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1225,11 +1211,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template" + "Swag Customized Products Template Configuration Share" ], - "summary": "Create a new Swag Customized Products Template resources.", + "summary": "Create a new Swag Customized Products Template Configuration Share resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplate", + "operationId": "createSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "_response", @@ -1248,14 +1234,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -1267,7 +1253,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1282,7 +1268,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1298,14 +1284,14 @@ } } }, - "/search/swag-customized-products-template": { + "/search/swag-customized-products-template-configuration-share": { "post": { "tags": [ - "Swag Customized Products Template" + "Swag Customized Products Template Configuration Share" ], - "summary": "Search for the Swag Customized Products Template resources.", + "summary": "Search for the Swag Customized Products Template Configuration Share resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplate", + "operationId": "searchSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "sw-include-search-info", @@ -1333,7 +1319,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplate", + "description": "List of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -1347,7 +1333,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1365,7 +1351,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1382,19 +1368,19 @@ } } }, - "/swag-customized-products-template/{id}": { + "/swag-customized-products-template-configuration-share/{id}": { "get": { "tags": [ - "Swag Customized Products Template" + "Swag Customized Products Template Configuration Share" ], - "summary": "Detailed information about a Swag Customized Products Template resource.", + "summary": "Detailed information about a Swag Customized Products Template Configuration Share resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplate", + "operationId": "getSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template", + "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", @@ -1404,7 +1390,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -1416,7 +1402,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1431,7 +1417,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1448,16 +1434,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template" + "Swag Customized Products Template Configuration Share" ], - "summary": "Delete a Swag Customized Products Template resource.", + "summary": "Delete a Swag Customized Products Template Configuration Share resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplate", + "operationId": "deleteSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template", + "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", @@ -1488,16 +1474,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template" + "Swag Customized Products Template Configuration Share" ], - "summary": "Partially update information about a Swag Customized Products Template resource.", + "summary": "Partially update information about a Swag Customized Products Template Configuration Share resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplate", + "operationId": "updateSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template", + "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", @@ -1515,18 +1501,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template resource.", + "description": "Partially update information about a Swag Customized Products Template Configuration Share resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -1538,7 +1524,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1553,7 +1539,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1572,14 +1558,14 @@ } } }, - "/aggregate/swag-customized-products-template": { + "/aggregate/swag-customized-products-template-configuration-share": { "post": { "tags": [ - "Swag Customized Products Template" + "Swag Customized Products Template Configuration Share" ], - "summary": "Aggregate for the Swag Customized Products Template resources.", + "summary": "Aggregate for the Swag Customized Products Template Configuration Share resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplate", + "operationId": "aggregateSwagCustomizedProductsTemplateConfigurationShare", "requestBody": { "required": true, "content": { @@ -1603,7 +1589,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplate", + "description": "List of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -1617,7 +1603,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1635,7 +1621,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -1652,14 +1638,14 @@ } } }, - "/swag-customized-products-template-configuration": { + "/swag-customized-products-template-exclusion": { "get": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion" ], - "summary": "List with basic information of Swag Customized Products Template Configuration resources.", + "summary": "List with basic information of Swag Customized Products Template Exclusion resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationList", + "operationId": "getSwagCustomizedProductsTemplateExclusionList", "parameters": [ { "name": "limit", @@ -1688,7 +1674,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Configuration resources.", + "description": "List of Swag Customized Products Template Exclusion resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1707,7 +1693,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } ] @@ -1721,16 +1707,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-configuration?limit=25" + "example": "/swag-customized-products-template-exclusion?limit=25" }, "last": { - "example": "/swag-customized-products-template-configuration?limit=25&page=11" + "example": "/swag-customized-products-template-exclusion?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-configuration?limit=25&page=4" + "example": "/swag-customized-products-template-exclusion?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-configuration?limit=25&page=2" + "example": "/swag-customized-products-template-exclusion?limit=25&page=2" } } } @@ -1751,7 +1737,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -1766,11 +1752,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion" ], - "summary": "Create a new Swag Customized Products Template Configuration resources.", + "summary": "Create a new Swag Customized Products Template Exclusion resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateConfiguration", + "operationId": "createSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "_response", @@ -1789,14 +1775,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -1808,7 +1794,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -1823,7 +1809,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -1839,14 +1825,14 @@ } } }, - "/search/swag-customized-products-template-configuration": { + "/search/swag-customized-products-template-exclusion": { "post": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion" ], - "summary": "Search for the Swag Customized Products Template Configuration resources.", + "summary": "Search for the Swag Customized Products Template Exclusion resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateConfiguration", + "operationId": "searchSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "sw-include-search-info", @@ -1874,7 +1860,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfiguration", + "description": "List of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -1888,7 +1874,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -1906,7 +1892,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -1923,19 +1909,19 @@ } } }, - "/swag-customized-products-template-configuration/{id}": { + "/swag-customized-products-template-exclusion/{id}": { "get": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion" ], - "summary": "Detailed information about a Swag Customized Products Template Configuration resource.", + "summary": "Detailed information about a Swag Customized Products Template Exclusion resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfiguration", + "operationId": "getSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", + "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", @@ -1945,7 +1931,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -1957,7 +1943,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -1972,7 +1958,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -1989,16 +1975,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion" ], - "summary": "Delete a Swag Customized Products Template Configuration resource.", + "summary": "Delete a Swag Customized Products Template Exclusion resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateConfiguration", + "operationId": "deleteSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", + "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", @@ -2029,16 +2015,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion" ], - "summary": "Partially update information about a Swag Customized Products Template Configuration resource.", + "summary": "Partially update information about a Swag Customized Products Template Exclusion resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateConfiguration", + "operationId": "updateSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", + "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", @@ -2056,18 +2042,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Configuration resource.", + "description": "Partially update information about a Swag Customized Products Template Exclusion resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -2079,7 +2065,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -2094,7 +2080,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -2113,14 +2099,14 @@ } } }, - "/aggregate/swag-customized-products-template-configuration": { + "/aggregate/swag-customized-products-template-exclusion": { "post": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion" ], - "summary": "Aggregate for the Swag Customized Products Template Configuration resources.", + "summary": "Aggregate for the Swag Customized Products Template Exclusion resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateConfiguration", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusion", "requestBody": { "required": true, "content": { @@ -2144,7 +2130,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfiguration", + "description": "List of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -2158,7 +2144,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -2176,7 +2162,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -2193,14 +2179,14 @@ } } }, - "/swag-customized-products-template-configuration-share": { + "/swag-customized-products-template-exclusion-condition": { "get": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "List with basic information of Swag Customized Products Template Configuration Share resources.", + "summary": "List with basic information of Swag Customized Products Template Exclusion Condition resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationShareList", + "operationId": "getSwagCustomizedProductsTemplateExclusionConditionList", "parameters": [ { "name": "limit", @@ -2229,7 +2215,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Configuration Share resources.", + "description": "List of Swag Customized Products Template Exclusion Condition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2248,7 +2234,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } ] @@ -2262,16 +2248,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-configuration-share?limit=25" + "example": "/swag-customized-products-template-exclusion-condition?limit=25" }, "last": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=11" + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=4" + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=2" + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=2" } } } @@ -2292,7 +2278,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2307,11 +2293,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Create a new Swag Customized Products Template Configuration Share resources.", + "summary": "Create a new Swag Customized Products Template Exclusion Condition resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "createSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "_response", @@ -2330,14 +2316,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -2349,7 +2335,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2364,7 +2350,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2380,14 +2366,14 @@ } } }, - "/search/swag-customized-products-template-configuration-share": { + "/search/swag-customized-products-template-exclusion-condition": { "post": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Search for the Swag Customized Products Template Configuration Share resources.", + "summary": "Search for the Swag Customized Products Template Exclusion Condition resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "searchSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "sw-include-search-info", @@ -2415,7 +2401,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfigurationShare", + "description": "List of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -2429,7 +2415,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2447,7 +2433,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2464,19 +2450,19 @@ } } }, - "/swag-customized-products-template-configuration-share/{id}": { + "/swag-customized-products-template-exclusion-condition/{id}": { "get": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Detailed information about a Swag Customized Products Template Configuration Share resource.", + "summary": "Detailed information about a Swag Customized Products Template Exclusion Condition resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "getSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", @@ -2486,7 +2472,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -2498,7 +2484,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2513,7 +2499,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2530,16 +2516,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Delete a Swag Customized Products Template Configuration Share resource.", + "summary": "Delete a Swag Customized Products Template Exclusion Condition resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "deleteSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", @@ -2570,16 +2556,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Partially update information about a Swag Customized Products Template Configuration Share resource.", + "summary": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "updateSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", @@ -2597,18 +2583,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Configuration Share resource.", + "description": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -2620,7 +2606,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2635,7 +2621,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2654,14 +2640,14 @@ } } }, - "/aggregate/swag-customized-products-template-configuration-share": { + "/aggregate/swag-customized-products-template-exclusion-condition": { "post": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Aggregate for the Swag Customized Products Template Configuration Share resources.", + "summary": "Aggregate for the Swag Customized Products Template Exclusion Condition resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusionCondition", "requestBody": { "required": true, "content": { @@ -2685,7 +2671,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfigurationShare", + "description": "List of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -2699,7 +2685,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2717,7 +2703,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -2734,14 +2720,14 @@ } } }, - "/swag-customized-products-template-exclusion": { + "/swag-customized-products-template-exclusion-operator": { "get": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion resources.", + "summary": "List with basic information of Swag Customized Products Template Exclusion Operator resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionList", + "operationId": "getSwagCustomizedProductsTemplateExclusionOperatorList", "parameters": [ { "name": "limit", @@ -2770,7 +2756,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion resources.", + "description": "List of Swag Customized Products Template Exclusion Operator resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2789,7 +2775,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } ] @@ -2803,16 +2789,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion?limit=25" + "example": "/swag-customized-products-template-exclusion-operator?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=11" + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=4" + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=2" + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=2" } } } @@ -2833,7 +2819,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -2848,11 +2834,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Create a new Swag Customized Products Template Exclusion resources.", + "summary": "Create a new Swag Customized Products Template Exclusion Operator resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusion", + "operationId": "createSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "_response", @@ -2871,14 +2857,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -2890,7 +2876,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -2905,7 +2891,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -2921,14 +2907,14 @@ } } }, - "/search/swag-customized-products-template-exclusion": { + "/search/swag-customized-products-template-exclusion-operator": { "post": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Search for the Swag Customized Products Template Exclusion resources.", + "summary": "Search for the Swag Customized Products Template Exclusion Operator resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusion", + "operationId": "searchSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "sw-include-search-info", @@ -2956,7 +2942,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusion", + "description": "List of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -2970,7 +2956,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -2988,7 +2974,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3005,19 +2991,19 @@ } } }, - "/swag-customized-products-template-exclusion/{id}": { + "/swag-customized-products-template-exclusion-operator/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion resource.", + "summary": "Detailed information about a Swag Customized Products Template Exclusion Operator resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusion", + "operationId": "getSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", @@ -3027,7 +3013,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -3039,7 +3025,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3054,7 +3040,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3071,16 +3057,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Delete a Swag Customized Products Template Exclusion resource.", + "summary": "Delete a Swag Customized Products Template Exclusion Operator resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusion", + "operationId": "deleteSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", @@ -3111,16 +3097,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion resource.", + "summary": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusion", + "operationId": "updateSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", @@ -3138,18 +3124,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Exclusion resource.", + "description": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -3161,7 +3147,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3176,7 +3162,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3195,14 +3181,14 @@ } } }, - "/aggregate/swag-customized-products-template-exclusion": { + "/aggregate/swag-customized-products-template-exclusion-operator": { "post": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Aggregate for the Swag Customized Products Template Exclusion resources.", + "summary": "Aggregate for the Swag Customized Products Template Exclusion Operator resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateExclusion", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusionOperator", "requestBody": { "required": true, "content": { @@ -3226,7 +3212,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusion", + "description": "List of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -3240,7 +3226,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3258,7 +3244,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -3275,14 +3261,14 @@ } } }, - "/swag-customized-products-template-exclusion-condition": { + "/swag-customized-products-template-option": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion Condition resources.", + "summary": "List with basic information of Swag Customized Products Template Option resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionConditionList", + "operationId": "getSwagCustomizedProductsTemplateOptionList", "parameters": [ { "name": "limit", @@ -3311,7 +3297,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion Condition resources.", + "description": "List of Swag Customized Products Template Option resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3330,7 +3316,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } ] @@ -3344,16 +3330,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25" + "example": "/swag-customized-products-template-option?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=11" + "example": "/swag-customized-products-template-option?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=4" + "example": "/swag-customized-products-template-option?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=2" + "example": "/swag-customized-products-template-option?limit=25&page=2" } } } @@ -3374,7 +3360,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3389,11 +3375,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option" ], - "summary": "Create a new Swag Customized Products Template Exclusion Condition resources.", + "summary": "Create a new Swag Customized Products Template Option resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "createSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "_response", @@ -3412,14 +3398,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -3431,7 +3417,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3446,7 +3432,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3462,14 +3448,14 @@ } } }, - "/search/swag-customized-products-template-exclusion-condition": { + "/search/swag-customized-products-template-option": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option" ], - "summary": "Search for the Swag Customized Products Template Exclusion Condition resources.", + "summary": "Search for the Swag Customized Products Template Option resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "searchSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "sw-include-search-info", @@ -3497,7 +3483,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionCondition", + "description": "List of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -3511,7 +3497,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3529,7 +3515,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3546,19 +3532,19 @@ } } }, - "/swag-customized-products-template-exclusion-condition/{id}": { + "/swag-customized-products-template-option/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion Condition resource.", + "summary": "Detailed information about a Swag Customized Products Template Option resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "getSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", @@ -3568,7 +3554,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -3580,7 +3566,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3595,7 +3581,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3612,16 +3598,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option" ], - "summary": "Delete a Swag Customized Products Template Exclusion Condition resource.", + "summary": "Delete a Swag Customized Products Template Option resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "deleteSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", @@ -3652,16 +3638,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", + "summary": "Partially update information about a Swag Customized Products Template Option resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "updateSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", @@ -3679,18 +3665,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", + "description": "Partially update information about a Swag Customized Products Template Option resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -3702,7 +3688,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3717,7 +3703,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3736,14 +3722,14 @@ } } }, - "/aggregate/swag-customized-products-template-exclusion-condition": { + "/aggregate/swag-customized-products-template-option": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option" ], - "summary": "Aggregate for the Swag Customized Products Template Exclusion Condition resources.", + "summary": "Aggregate for the Swag Customized Products Template Option resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "aggregateSwagCustomizedProductsTemplateOption", "requestBody": { "required": true, "content": { @@ -3767,7 +3753,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionCondition", + "description": "List of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -3781,7 +3767,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3799,7 +3785,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -3816,14 +3802,14 @@ } } }, - "/swag-customized-products-template-exclusion-operator": { + "/swag-customized-products-template-option-price": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Price" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion Operator resources.", + "summary": "List with basic information of Swag Customized Products Template Option Price resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionOperatorList", + "operationId": "getSwagCustomizedProductsTemplateOptionPriceList", "parameters": [ { "name": "limit", @@ -3852,7 +3838,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion Operator resources.", + "description": "List of Swag Customized Products Template Option Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3871,7 +3857,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } ] @@ -3885,16 +3871,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25" + "example": "/swag-customized-products-template-option-price?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=11" + "example": "/swag-customized-products-template-option-price?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=4" + "example": "/swag-customized-products-template-option-price?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=2" + "example": "/swag-customized-products-template-option-price?limit=25&page=2" } } } @@ -3915,7 +3901,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -3930,11 +3916,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Price" ], - "summary": "Create a new Swag Customized Products Template Exclusion Operator resources.", + "summary": "Create a new Swag Customized Products Template Option Price resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "createSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "_response", @@ -3953,14 +3939,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -3972,7 +3958,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -3987,7 +3973,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4003,14 +3989,14 @@ } } }, - "/search/swag-customized-products-template-exclusion-operator": { + "/search/swag-customized-products-template-option-price": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Price" ], - "summary": "Search for the Swag Customized Products Template Exclusion Operator resources.", + "summary": "Search for the Swag Customized Products Template Option Price resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "searchSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "sw-include-search-info", @@ -4038,7 +4024,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionOperator", + "description": "List of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -4052,7 +4038,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4070,7 +4056,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4087,19 +4073,19 @@ } } }, - "/swag-customized-products-template-exclusion-operator/{id}": { + "/swag-customized-products-template-option-price/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Price" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Detailed information about a Swag Customized Products Template Option Price resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "getSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", @@ -4109,7 +4095,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -4121,7 +4107,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4136,7 +4122,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4153,16 +4139,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Price" ], - "summary": "Delete a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Delete a Swag Customized Products Template Option Price resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "deleteSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", @@ -4193,16 +4179,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Price" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Partially update information about a Swag Customized Products Template Option Price resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "updateSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", @@ -4220,18 +4206,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", + "description": "Partially update information about a Swag Customized Products Template Option Price resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -4243,7 +4229,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4258,7 +4244,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4277,14 +4263,14 @@ } } }, - "/aggregate/swag-customized-products-template-exclusion-operator": { + "/aggregate/swag-customized-products-template-option-price": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Price" ], - "summary": "Aggregate for the Swag Customized Products Template Exclusion Operator resources.", + "summary": "Aggregate for the Swag Customized Products Template Option Price resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionPrice", "requestBody": { "required": true, "content": { @@ -4308,7 +4294,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionOperator", + "description": "List of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -4322,7 +4308,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4340,7 +4326,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -4357,14 +4343,14 @@ } } }, - "/swag-customized-products-template-option": { + "/swag-customized-products-template-option-value": { "get": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Option Value" ], - "summary": "List with basic information of Swag Customized Products Template Option resources.", + "summary": "List with basic information of Swag Customized Products Template Option Value resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionList", + "operationId": "getSwagCustomizedProductsTemplateOptionValueList", "parameters": [ { "name": "limit", @@ -4393,7 +4379,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Option resources.", + "description": "List of Swag Customized Products Template Option Value resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4412,7 +4398,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } ] @@ -4426,16 +4412,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-option?limit=25" + "example": "/swag-customized-products-template-option-value?limit=25" }, "last": { - "example": "/swag-customized-products-template-option?limit=25&page=11" + "example": "/swag-customized-products-template-option-value?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-option?limit=25&page=4" + "example": "/swag-customized-products-template-option-value?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-option?limit=25&page=2" + "example": "/swag-customized-products-template-option-value?limit=25&page=2" } } } @@ -4456,7 +4442,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -4471,11 +4457,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Option Value" ], - "summary": "Create a new Swag Customized Products Template Option resources.", + "summary": "Create a new Swag Customized Products Template Option Value resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateOption", + "operationId": "createSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "_response", @@ -4494,14 +4480,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -4513,7 +4499,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -4528,7 +4514,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -4544,14 +4530,14 @@ } } }, - "/search/swag-customized-products-template-option": { + "/search/swag-customized-products-template-option-value": { "post": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Option Value" ], - "summary": "Search for the Swag Customized Products Template Option resources.", + "summary": "Search for the Swag Customized Products Template Option Value resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOption", + "operationId": "searchSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "sw-include-search-info", @@ -4579,548 +4565,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOption", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/swag-customized-products-template-option/{id}": { - "get": { - "tags": [ - "Swag Customized Products Template Option" - ], - "summary": "Detailed information about a Swag Customized Products Template Option resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateOption", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Swag Customized Products Template Option" - ], - "summary": "Delete a Swag Customized Products Template Option resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOption", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Swag Customized Products Template Option" - ], - "summary": "Partially update information about a Swag Customized Products Template Option resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOption", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option", - "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 Swag Customized Products Template Option resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/swag-customized-products-template-option": { - "post": { - "tags": [ - "Swag Customized Products Template Option" - ], - "summary": "Aggregate for the Swag Customized Products Template Option resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateOption", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SwagCustomizedProductsTemplateOption", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/swag-customized-products-template-option-price": { - "get": { - "tags": [ - "Swag Customized Products Template Option Price" - ], - "summary": "List with basic information of Swag Customized Products Template Option Price resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionPriceList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Swag Customized Products Template Option Price 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/SwagCustomizedProductsTemplateOptionPrice" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/swag-customized-products-template-option-price?limit=25" - }, - "last": { - "example": "/swag-customized-products-template-option-price?limit=25&page=11" - }, - "next": { - "example": "/swag-customized-products-template-option-price?limit=25&page=4" - }, - "prev": { - "example": "/swag-customized-products-template-option-price?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Swag Customized Products Template Option Price" - ], - "summary": "Create a new Swag Customized Products Template Option Price resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplateOptionPrice", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/swag-customized-products-template-option-price": { - "post": { - "tags": [ - "Swag Customized Products Template Option Price" - ], - "summary": "Search for the Swag Customized Products Template Option Price resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOptionPrice", - "parameters": [ - { - "name": "sw-include-search-info", - "in": "header", - "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", - "schema": { - "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of SwagCustomizedProductsTemplateOptionPrice", + "description": "List of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -5134,7 +4579,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -5152,7 +4597,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -5169,19 +4614,19 @@ } } }, - "/swag-customized-products-template-option-price/{id}": { + "/swag-customized-products-template-option-value/{id}": { "get": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Option Value" ], - "summary": "Detailed information about a Swag Customized Products Template Option Price resource.", + "summary": "Detailed information about a Swag Customized Products Template Option Value resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionPrice", + "operationId": "getSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_price", + "description": "Identifier for the swag_customized_products_template_option_value", "required": true, "schema": { "type": "string", @@ -5191,7 +4636,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -5203,7 +4648,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -5218,7 +4663,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -5235,16 +4680,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Option Value" ], - "summary": "Delete a Swag Customized Products Template Option Price resource.", + "summary": "Delete a Swag Customized Products Template Option Value resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOptionPrice", + "operationId": "deleteSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_price", + "description": "Identifier for the swag_customized_products_template_option_value", "required": true, "schema": { "type": "string", @@ -5275,16 +4720,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Option Value" ], - "summary": "Partially update information about a Swag Customized Products Template Option Price resource.", + "summary": "Partially update information about a Swag Customized Products Template Option Value resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOptionPrice", + "operationId": "updateSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_price", + "description": "Identifier for the swag_customized_products_template_option_value", "required": true, "schema": { "type": "string", @@ -5302,18 +4747,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option Price resource.", + "description": "Partially update information about a Swag Customized Products Template Option Value resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -5325,7 +4770,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -5340,7 +4785,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -5359,14 +4804,14 @@ } } }, - "/aggregate/swag-customized-products-template-option-price": { + "/aggregate/swag-customized-products-template-option-value": { "post": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Option Value" ], - "summary": "Aggregate for the Swag Customized Products Template Option Price resources.", + "summary": "Aggregate for the Swag Customized Products Template Option Value resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateOptionPrice", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionValue", "requestBody": { "required": true, "content": { @@ -5390,7 +4835,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionPrice", + "description": "List of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -5404,7 +4849,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -5422,7 +4867,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -5439,14 +4884,14 @@ } } }, - "/swag-customized-products-template-option-value": { + "/swag-customized-products-template-option-value-price": { "get": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Option Value Price" ], - "summary": "List with basic information of Swag Customized Products Template Option Value resources.", + "summary": "List with basic information of Swag Customized Products Template Option Value Price resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionValueList", + "operationId": "getSwagCustomizedProductsTemplateOptionValuePriceList", "parameters": [ { "name": "limit", @@ -5475,7 +4920,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Option Value resources.", + "description": "List of Swag Customized Products Template Option Value Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5494,7 +4939,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } ] @@ -5508,16 +4953,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-option-value?limit=25" + "example": "/swag-customized-products-template-option-value-price?limit=25" }, "last": { - "example": "/swag-customized-products-template-option-value?limit=25&page=11" + "example": "/swag-customized-products-template-option-value-price?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-option-value?limit=25&page=4" + "example": "/swag-customized-products-template-option-value-price?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-option-value?limit=25&page=2" + "example": "/swag-customized-products-template-option-value-price?limit=25&page=2" } } } @@ -5538,7 +4983,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -5553,11 +4998,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Option Value Price" ], - "summary": "Create a new Swag Customized Products Template Option Value resources.", + "summary": "Create a new Swag Customized Products Template Option Value Price resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateOptionValue", + "operationId": "createSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { "name": "_response", @@ -5576,14 +5021,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { @@ -5595,7 +5040,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -5610,7 +5055,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -5626,14 +5071,14 @@ } } }, - "/search/swag-customized-products-template-option-value": { + "/search/swag-customized-products-template-option-value-price": { "post": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Option Value Price" ], - "summary": "Search for the Swag Customized Products Template Option Value resources.", + "summary": "Search for the Swag Customized Products Template Option Value Price resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOptionValue", + "operationId": "searchSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { "name": "sw-include-search-info", @@ -5661,7 +5106,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValue", + "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { @@ -5675,7 +5120,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -5693,7 +5138,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -5710,19 +5155,19 @@ } } }, - "/swag-customized-products-template-option-value/{id}": { + "/swag-customized-products-template-option-value-price/{id}": { "get": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Option Value Price" ], - "summary": "Detailed information about a Swag Customized Products Template Option Value resource.", + "summary": "Detailed information about a Swag Customized Products Template Option Value Price resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionValue", + "operationId": "getSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value", + "description": "Identifier for the swag_customized_products_template_option_value_price", "required": true, "schema": { "type": "string", @@ -5732,7 +5177,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { @@ -5744,7 +5189,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -5759,7 +5204,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -5776,16 +5221,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Option Value Price" ], - "summary": "Delete a Swag Customized Products Template Option Value resource.", + "summary": "Delete a Swag Customized Products Template Option Value Price resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOptionValue", + "operationId": "deleteSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value", + "description": "Identifier for the swag_customized_products_template_option_value_price", "required": true, "schema": { "type": "string", @@ -5816,16 +5261,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Option Value Price" ], - "summary": "Partially update information about a Swag Customized Products Template Option Value resource.", + "summary": "Partially update information about a Swag Customized Products Template Option Value Price resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOptionValue", + "operationId": "updateSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value", + "description": "Identifier for the swag_customized_products_template_option_value_price", "required": true, "schema": { "type": "string", @@ -5843,18 +5288,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option Value resource.", + "description": "Partially update information about a Swag Customized Products Template Option Value Price resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { @@ -5866,7 +5311,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -5881,7 +5326,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -5900,14 +5345,14 @@ } } }, - "/aggregate/swag-customized-products-template-option-value": { + "/aggregate/swag-customized-products-template-option-value-price": { "post": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Option Value Price" ], - "summary": "Aggregate for the Swag Customized Products Template Option Value resources.", + "summary": "Aggregate for the Swag Customized Products Template Option Value Price resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateOptionValue", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionValuePrice", "requestBody": { "required": true, "content": { @@ -5929,277 +5374,6 @@ } } }, - "responses": { - "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValue", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/swag-customized-products-template-option-value-price": { - "get": { - "tags": [ - "Swag Customized Products Template Option Value Price" - ], - "summary": "List with basic information of Swag Customized Products Template Option Value Price resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionValuePriceList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Swag Customized Products Template Option Value Price 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/SwagCustomizedProductsTemplateOptionValuePrice" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/swag-customized-products-template-option-value-price?limit=25" - }, - "last": { - "example": "/swag-customized-products-template-option-value-price?limit=25&page=11" - }, - "next": { - "example": "/swag-customized-products-template-option-value-price?limit=25&page=4" - }, - "prev": { - "example": "/swag-customized-products-template-option-value-price?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Swag Customized Products Template Option Value Price" - ], - "summary": "Create a new Swag Customized Products Template Option Value Price resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplateOptionValuePrice", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/swag-customized-products-template-option-value-price": { - "post": { - "tags": [ - "Swag Customized Products Template Option Value Price" - ], - "summary": "Search for the Swag Customized Products Template Option Value Price resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOptionValuePrice", - "parameters": [ - { - "name": "sw-include-search-info", - "in": "header", - "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", - "schema": { - "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", @@ -6251,93 +5425,116 @@ } } }, - "/swag-customized-products-template-option-value-price/{id}": { - "get": { + "/_action/validation/email": { + "post": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Email support validation" ], - "summary": "Detailed information about a Swag Customized Products Template Option Value Price resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionValuePrice", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value_price", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Email support.", + "description": "Checks a given email string.", + "operationId": "supportsEmail", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "email" + ], + "properties": { + "email": { + "description": "The email to be verified.", + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "204": { + "description": "Email is supported" + }, + "400": { + "description": "Invalid request payload. The argument 'email' may be missing.", "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, + "properties": { + "errors": { + "description": "Contains the error message.", + "type": "array" + } + }, + "type": "object" + }, + "example": { + "errors": [ { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" - } - } + "code": "0", + "status": "400", + "title": "Unprocessable Content", + "detail": "This value should not be blank." } ] } - }, + } + } + }, + "422": { + "description": "Email address is not supported.", + "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "errors": { + "description": "Contains the validation error.", + "type": "array" } - } + }, + "type": "object" + }, + "example": { + "errors": [ + { + "code": "0", + "status": "422", + "title": "Unprocessable Content", + "detail": "This value is not a supported email address." + } + ] } } } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } - }, - "delete": { + } + }, + "/app-system/shop/verify": { + "get": { "tags": [ - "Swag Customized Products Template Option Value Price" + "App System", + "Public" ], - "summary": "Delete a Swag Customized Products Template Option Value Price resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOptionValuePrice", + "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", "parameters": [ { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value_price", + "name": "runId", + "in": "query", + "description": "A unique identifier used to look up the token", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } }, { - "name": "_response", + "name": "token", "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, + "description": "A unique identifier", + "required": true, "schema": { "type": "string" } @@ -6345,110 +5542,213 @@ ], "responses": { "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "description": "An empty response signalling successful verification." }, - "401": { - "$ref": "#/components/responses/401" + "400": { + "description": "Malformed request or unsuccessful verification." } } - }, - "patch": { + } + }, + "/_action/system-config": { + "get": { "tags": [ - "Swag Customized Products Template Option Value Price" + "System Config" ], - "summary": "Partially update information about a Swag Customized Products Template Option Value Price resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOptionValuePrice", + "summary": "Get configuration values", + "description": "Returns the configuration values for the given domain and optional sales channel.", + "operationId": "getConfigurationValues", "parameters": [ { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value_price", + "name": "domain", + "in": "query", + "description": "The configuration domain.", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } }, { - "name": "_response", + "name": "salesChannelId", "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, + "description": "The sales channel ID to scope the configuration to.", + "schema": { + "type": "string" + } + }, + { + "name": "inherit", + "in": "query", + "description": "Whether to include inherited (global) values.", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Returns the configuration values as a key-value object." + } + } + }, + "post": { + "tags": [ + "System Config" + ], + "summary": "Save configuration values", + "description": "Saves the given configuration key-value pairs for the given sales channel.", + "operationId": "saveConfiguration", + "parameters": [ + { + "name": "salesChannelId", + "in": "query", + "description": "The sales channel ID to scope the configuration to.", "schema": { "type": "string" } + }, + { + "name": "silent", + "in": "query", + "description": "If true, the HTTP cache will not be invalidated. Use this for internal configuration values that do not affect the storefront.", + "schema": { + "type": "boolean", + "default": false + } } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option Value Price resource.", + "description": "Key-value pairs of configuration values to save.", + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "type": "object", + "additionalProperties": true } } } }, + "responses": { + "204": { + "description": "Configuration saved successfully." + } + } + } + }, + "/_action/system-config/check": { + "get": { + "tags": [ + "System Config" + ], + "summary": "Check configuration", + "description": "Checks if a configuration domain exists.", + "operationId": "checkConfiguration", + "parameters": [ + { + "name": "domain", + "in": "query", + "description": "The configuration domain to check.", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { + "description": "Returns whether the configuration domain exists." + } + } + } + }, + "/_action/system-config/schema": { + "get": { + "tags": [ + "System Config" + ], + "summary": "Get configuration schema", + "description": "Returns the configuration schema for the given domain.", + "operationId": "getConfiguration", + "parameters": [ + { + "name": "domain", + "in": "query", + "description": "The configuration domain.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns the configuration schema." + } + } + } + }, + "/_action/system-config/batch": { + "post": { + "tags": [ + "System Config" + ], + "summary": "Batch save configuration values", + "description": "Saves configuration values for multiple sales channels at once. The request body is keyed by sales channel ID (use \"null\" for global scope).", + "operationId": "batchSaveConfiguration", + "parameters": [ + { + "name": "silent", + "in": "query", + "description": "If true, the HTTP cache will not be invalidated. Use this for internal configuration values that do not affect the storefront.", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "requestBody": { + "description": "Object keyed by sales channel ID, each containing key-value pairs of configuration values.", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" - } - } + "additionalProperties": true } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" + } + }, + "responses": { + "204": { + "description": "Configuration saved successfully." } } } }, - "/aggregate/swag-customized-products-template-option-value-price": { + "/_action/media/{mediaId}/external-thumbnails": { "post": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Asset Management" + ], + "summary": "Add external thumbnails to media", + "description": "Attaches external thumbnail URLs to an existing external media entity. The media must have an HTTP/HTTPS path (i.e. be an external media link).\n\nUsed for CDNs that pre-generated thumbnails alongside the main media file.\nNot to be confused with [remote thumbnails](https://developer.shopware.com/docs/guides/plugins/plugins/content/media/remote-thumbnail-generation.html#remote-thumbnail-generation), which are generated based on a pattern.\n\nThe thumbnail sized are matched against existing thumbnails sizes and a matching size will automatically be assigned. If there's not existing size, a **new thumbnail size will automatically be created** for each missing size.", + "operationId": "addExternalThumbnails", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "description": "ID of the external media entity the thumbnails will be attached to.", + "required": true, + "schema": { + "$ref": "#/components/schemas/MediaId" + } + } ], - "summary": "Aggregate for the Swag Customized Products Template Option Value Price resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateOptionValuePrice", "requestBody": { "required": true, "content": { @@ -6456,56 +5756,75 @@ "schema": { "type": "object", "properties": { - "aggregations": { + "thumbnails": { "type": "array", + "description": "List of external thumbnails to attach", "items": { - "$ref": "#/components/schemas/Aggregation" + "$ref": "#/components/schemas/ExternalThumbnail" } } - }, - "required": [ - "aggregations" - ] + } } } } }, "responses": { - "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", + "201": { + "description": "Thumbnails attached successfully", "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" + "type": "object", + "properties": { + "mediaId": { + "description": "ID of the media entity the thumbnails were attached to.", + "$ref": "#/components/schemas/MediaId" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" - } - } - } + "thumbnailsCreated": { + "type": "integer" } - ] + } } - }, + } + } + }, + "400": { + "description": "Media is not an external media entity or path is missing" + }, + "404": { + "description": "Media entity not found" + } + } + }, + "delete": { + "tags": [ + "Asset Management" + ], + "summary": "Delete all external thumbnails from media", + "description": "Removes all externally stored thumbnail entries from the given media entity. Only works on external media (media with an HTTP/HTTPS path). Used to replace outdated thumbnails with new ones.", + "operationId": "deleteExternalThumbnails", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "description": "ID of the external media entity the thumbnails will be deleted from..", + "required": true, + "schema": { + "$ref": "#/components/schemas/MediaId" + } + } + ], + "responses": { + "200": { + "description": "Thumbnails deleted successfully", + "content": { "application/json": { "schema": { "type": "object", "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" - } + "mediaId": { + "description": "ID of the media entity the thumbnails were deleted from.", + "$ref": "#/components/schemas/MediaId" } } } @@ -6513,10 +5832,31 @@ } }, "400": { - "$ref": "#/components/responses/400" + "description": "Media is not an external media entity or path is missing" + }, + "404": { + "description": "Media entity not found" + } + } + } + }, + "/_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": { - "$ref": "#/components/responses/401" + "description": "Unauthorized - the access token is missing or invalid." + }, + "403": { + "description": "The authenticated source does not have a user ID associated." } } } @@ -13922,40 +13262,6 @@ "format": "date-time", "readOnly": true }, - "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" - } - }, - "type": "object" - }, "relationships": { "properties": { "group": { @@ -14762,40 +14068,6 @@ "format": "date-time", "readOnly": true }, - "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" - } - }, - "type": "object" - }, "group": { "$ref": "#/components/schemas/CustomerGroup", "description": "Customer group determining pricing and permissions" @@ -20060,9 +19332,6 @@ "systemDefault": { "type": "boolean" }, - "wasModifiedByUser": { - "type": "boolean" - }, "senderName": { "type": "string" }, @@ -20185,9 +19454,6 @@ "systemDefault": { "type": "boolean" }, - "wasModifiedByUser": { - "type": "boolean" - }, "senderName": { "type": "string" }, @@ -21588,37 +20854,6 @@ }, "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": { @@ -22159,12 +21394,6 @@ "$ref": "#/components/schemas/ProductConfiguratorSetting" } }, - "productOpenGraphImages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, "orderLineItems": { "type": "array", "items": { @@ -24771,40 +24000,6 @@ "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": { @@ -25616,40 +24811,6 @@ "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)" @@ -30392,11 +29553,6 @@ "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": { @@ -30633,12 +29789,6 @@ "additionalProperties": false } }, - "ogTitle": { - "type": "string" - }, - "ogDescription": { - "type": "string" - }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -30948,36 +30098,6 @@ }, "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": { @@ -31759,11 +30879,6 @@ "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": { @@ -32000,12 +31115,6 @@ "additionalProperties": false } }, - "ogTitle": { - "type": "string" - }, - "ogDescription": { - "type": "string" - }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -32107,10 +31216,6 @@ "$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" }, @@ -33245,10 +32350,6 @@ "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" @@ -33514,10 +32615,6 @@ "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" @@ -36046,12 +35143,7 @@ "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", - "enum": [ - 10, - 20, - 30 - ] + "format": "int64" }, "createdAt": { "type": "string", @@ -36161,12 +35253,7 @@ "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", - "enum": [ - 10, - 20, - 30 - ] + "format": "int64" }, "createdAt": { "type": "string", @@ -39507,68 +38594,6 @@ }, "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": { @@ -40937,68 +39962,6 @@ }, "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": { @@ -41836,298 +40799,6 @@ }, "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": [ @@ -51109,20 +49780,6 @@ ], "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." } } }, @@ -53190,14 +51847,6 @@ "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/SwagCustomizedProducts-adminapi.summary.json b/SwagCustomizedProducts-adminapi.summary.json index 435861a..e780cc7 100644 --- a/SwagCustomizedProducts-adminapi.summary.json +++ b/SwagCustomizedProducts-adminapi.summary.json @@ -1,7 +1,12 @@ { "paths": [ - "/aggregate/sales-channel-tracking-customer", - "/aggregate/sales-channel-tracking-order", + "/_action/media/{mediaId}/external-thumbnails", + "/_action/system-config", + "/_action/system-config/batch", + "/_action/system-config/check", + "/_action/system-config/schema", + "/_action/user/logout", + "/_action/validation/email", "/aggregate/swag-customized-products-template", "/aggregate/swag-customized-products-template-configuration", "/aggregate/swag-customized-products-template-configuration-share", @@ -12,12 +17,7 @@ "/aggregate/swag-customized-products-template-option-price", "/aggregate/swag-customized-products-template-option-value", "/aggregate/swag-customized-products-template-option-value-price", - "/sales-channel-tracking-customer", - "/sales-channel-tracking-customer/{id}", - "/sales-channel-tracking-order", - "/sales-channel-tracking-order/{id}", - "/search/sales-channel-tracking-customer", - "/search/sales-channel-tracking-order", + "/app-system/shop/verify", "/search/swag-customized-products-template", "/search/swag-customized-products-template-configuration", "/search/swag-customized-products-template-configuration-share", @@ -324,10 +324,6 @@ "SalesChannelLanguage", "SalesChannelPaymentMethod", "SalesChannelShippingMethod", - "SalesChannelTrackingCustomer", - "SalesChannelTrackingCustomerJsonApi", - "SalesChannelTrackingOrder", - "SalesChannelTrackingOrderJsonApi", "SalesChannelType", "SalesChannelTypeJsonApi", "Salutation", diff --git a/SwagDigitalSalesRooms-adminapi.json b/SwagDigitalSalesRooms-adminapi.json index 277d16b..566ff36 100644 --- a/SwagDigitalSalesRooms-adminapi.json +++ b/SwagDigitalSalesRooms-adminapi.json @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.7.9999999-dev" + "version": "6.7.9.0" }, "servers": [ { @@ -4884,584 +4884,258 @@ } } }, - "/sales-channel-tracking-customer": { - "get": { - "tags": [ - "Sales Channel Tracking Customer", - "Experimental" - ], - "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": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Sales Channel Tracking Customer 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/SalesChannelTrackingCustomer" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/sales-channel-tracking-customer?limit=25" - }, - "last": { - "example": "/sales-channel-tracking-customer?limit=25&page=11" - }, - "next": { - "example": "/sales-channel-tracking-customer?limit=25&page=4" - }, - "prev": { - "example": "/sales-channel-tracking-customer?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, + "/_action/validation/email": { "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" - ], - "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": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Email support validation" ], + "summary": "Email support.", + "description": "Checks a given email string.", + "operationId": "supportsEmail", "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "required": [ + "email" + ], + "properties": { + "email": { + "description": "The email to be verified.", + "type": "string" + } + }, + "type": "object" } } } }, "responses": { - "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "204": { + "description": "Email is supported" + }, + "400": { + "description": "Invalid request payload. The argument 'email' may be missing.", "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, + "properties": { + "errors": { + "description": "Contains the error message.", + "type": "array" + } + }, + "type": "object" + }, + "example": { + "errors": [ { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" - } - } + "code": "0", + "status": "400", + "title": "Unprocessable Content", + "detail": "This value should not be blank." } ] } - }, + } + } + }, + "422": { + "description": "Email address is not supported.", + "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "errors": { + "description": "Contains the validation error.", + "type": "array" } - } + }, + "type": "object" + }, + "example": { + "errors": [ + { + "code": "0", + "status": "422", + "title": "Unprocessable Content", + "detail": "This value is not a supported email address." + } + ] } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/search/sales-channel-tracking-customer": { - "post": { + "/app-system/shop/verify": { + "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "App System", + "Public" ], - "summary": "Search for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "searchSalesChannelTrackingCustomer", + "summary": "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", "parameters": [ { - "name": "sw-include-search-info", - "in": "header", - "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "name": "runId", + "in": "query", + "description": "A unique identifier used to look up the token", + "required": true, "schema": { - "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" + "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + }, + { + "name": "token", + "in": "query", + "description": "A unique identifier", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { - "200": { - "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": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" - } - } - } - } - } - } + "204": { + "description": "An empty response signalling successful verification." }, "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + "description": "Malformed request or unsuccessful verification." } } } }, - "/sales-channel-tracking-customer/{id}": { + "/_action/system-config": { "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "System Config" ], - "summary": "Detailed information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingCustomer", + "summary": "Get configuration values", + "description": "Returns the configuration values for the given domain and optional sales channel.", + "operationId": "getConfigurationValues", "parameters": [ { - "name": "id", - "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "name": "domain", + "in": "query", + "description": "The configuration domain.", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "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": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" - } - } - } - } + "type": "string" } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Sales Channel Tracking Customer", - "Experimental" - ], - "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": "id", - "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", - "required": true, + "name": "salesChannelId", + "in": "query", + "description": "The sales channel ID to scope the configuration to.", "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } }, { - "name": "_response", + "name": "inherit", "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, + "description": "Whether to include inherited (global) values.", "schema": { - "type": "string" + "type": "boolean", + "default": false } } ], "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" + "200": { + "description": "Returns the configuration values as a key-value object." } } }, - "patch": { + "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "System Config" ], - "summary": "Partially update information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "updateSalesChannelTrackingCustomer", + "summary": "Save configuration values", + "description": "Saves the given configuration key-value pairs for the given sales channel.", + "operationId": "saveConfiguration", "parameters": [ { - "name": "id", - "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", - "required": true, + "name": "salesChannelId", + "in": "query", + "description": "The sales channel ID to scope the configuration to.", "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } }, { - "name": "_response", + "name": "silent", "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, + "description": "If true, the HTTP cache will not be invalidated. Use this for internal configuration values that do not affect the storefront.", "schema": { - "type": "string" + "type": "boolean", + "default": false } } ], "requestBody": { - "description": "Partially update information about a Sales Channel Tracking Customer resource.", + "description": "Key-value pairs of configuration values to save.", + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "type": "object", + "additionalProperties": true } } } }, "responses": { - "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": { - "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" + "204": { + "description": "Configuration saved successfully." } } } }, - "/aggregate/sales-channel-tracking-customer": { - "post": { + "/_action/system-config/check": { + "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "System Config" ], - "summary": "Aggregate for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "aggregateSalesChannelTrackingCustomer", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "Check configuration", + "description": "Checks if a configuration domain exists.", + "operationId": "checkConfiguration", + "parameters": [ + { + "name": "domain", + "in": "query", + "description": "The configuration domain to check.", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { - "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": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + "description": "Returns whether the configuration domain exists." } } } }, - "/sales-channel-tracking-order": { + "/_action/system-config/schema": { "get": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "System Config" ], - "summary": "List with basic information of Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingOrderList", + "summary": "Get configuration schema", + "description": "Returns the configuration schema for the given domain.", + "operationId": "getConfiguration", "parameters": [ { - "name": "limit", + "name": "domain", "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", + "description": "The configuration domain.", + "required": true, "schema": { "type": "string" } @@ -5469,179 +5143,68 @@ ], "responses": { "200": { - "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": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" + "description": "Returns the configuration schema." } } - }, + } + }, + "/_action/system-config/batch": { "post": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "System Config" ], - "summary": "Create a new Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "createSalesChannelTrackingOrder", + "summary": "Batch save configuration values", + "description": "Saves configuration values for multiple sales channels at once. The request body is keyed by sales channel ID (use \"null\" for global scope).", + "operationId": "batchSaveConfiguration", "parameters": [ { - "name": "_response", + "name": "silent", "in": "query", - "description": "Data format for response. Empty if none is provided.", + "description": "If true, the HTTP cache will not be invalidated. Use this for internal configuration values that do not affect the storefront.", "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] + "type": "boolean", + "default": false } } ], "requestBody": { + "description": "Object keyed by sales channel ID, each containing key-value pairs of configuration values.", + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": true + } } } } }, "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" - }, - "401": { - "$ref": "#/components/responses/401" + "204": { + "description": "Configuration saved successfully." } } } }, - "/search/sales-channel-tracking-order": { + "/_action/media/{mediaId}/external-thumbnails": { "post": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Asset Management" ], - "summary": "Search for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "searchSalesChannelTrackingOrder", + "summary": "Add external thumbnails to media", + "description": "Attaches external thumbnail URLs to an existing external media entity. The media must have an HTTP/HTTPS path (i.e. be an external media link).\n\nUsed for CDNs that pre-generated thumbnails alongside the main media file.\nNot to be confused with [remote thumbnails](https://developer.shopware.com/docs/guides/plugins/plugins/content/media/remote-thumbnail-generation.html#remote-thumbnail-generation), which are generated based on a pattern.\n\nThe thumbnail sized are matched against existing thumbnails sizes and a matching size will automatically be assigned. If there's not existing size, a **new thumbnail size will automatically be created** for each missing size.", + "operationId": "addExternalThumbnails", "parameters": [ { - "name": "sw-include-search-info", - "in": "header", - "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", + "name": "mediaId", + "in": "path", + "description": "ID of the external media entity the thumbnails will be attached to.", + "required": true, "schema": { - "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" + "$ref": "#/components/schemas/MediaId" } } ], @@ -5650,47 +5213,34 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "thumbnails": { + "type": "array", + "description": "List of external thumbnails to attach", + "items": { + "$ref": "#/components/schemas/ExternalThumbnail" + } + } + } } } } }, "responses": { - "200": { - "description": "List of SalesChannelTrackingOrder", + "201": { + "description": "Thumbnails attached successfully", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", "properties": { - "total": { - "type": "integer" + "mediaId": { + "description": "ID of the media entity the thumbnails were attached to.", + "$ref": "#/components/schemas/MediaId" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } + "thumbnailsCreated": { + "type": "integer" } } } @@ -5698,189 +5248,42 @@ } }, "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/sales-channel-tracking-order/{id}": { - "get": { - "tags": [ - "Sales Channel Tracking Order", - "Experimental" - ], - "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": "id", - "in": "path", - "description": "Identifier for the sales_channel_tracking_order", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "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" - } - } - } - } - } + "description": "Media is not an external media entity or path is missing" }, "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" + "description": "Media entity not found" } } }, "delete": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Asset Management" ], - "summary": "Delete a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "deleteSalesChannelTrackingOrder", + "summary": "Delete all external thumbnails from media", + "description": "Removes all externally stored thumbnail entries from the given media entity. Only works on external media (media with an HTTP/HTTPS path). Used to replace outdated thumbnails with new ones.", + "operationId": "deleteExternalThumbnails", "parameters": [ { - "name": "id", + "name": "mediaId", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "ID of the external media entity the thumbnails will be deleted from..", "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" + "$ref": "#/components/schemas/MediaId" } } ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Sales Channel Tracking Order", - "Experimental" - ], - "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": "id", - "in": "path", - "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", + "description": "Thumbnails deleted successfully", "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" + "mediaId": { + "description": "ID of the media entity the thumbnails were deleted from.", + "$ref": "#/components/schemas/MediaId" } } } @@ -5888,94 +5291,31 @@ } }, "400": { - "$ref": "#/components/responses/400" + "description": "Media is not an external media entity or path is missing" }, "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" + "description": "Media entity not found" } } } }, - "/aggregate/sales-channel-tracking-order": { + "/_action/user/logout": { "post": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Authorization & Authentication" ], - "summary": "Aggregate for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "aggregateSalesChannelTrackingOrder", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, + "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": { - "200": { - "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": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" + "204": { + "description": "Tokens have been revoked successfully." }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized - the access token is missing or invalid." + }, + "403": { + "description": "The authenticated source does not have a user ID associated." } } } @@ -14576,35 +13916,6 @@ }, "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": { @@ -15447,35 +14758,6 @@ }, "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": { @@ -23019,9 +22301,6 @@ "systemDefault": { "type": "boolean" }, - "wasModifiedByUser": { - "type": "boolean" - }, "senderName": { "type": "string" }, @@ -23144,9 +22423,6 @@ "systemDefault": { "type": "boolean" }, - "wasModifiedByUser": { - "type": "boolean" - }, "senderName": { "type": "string" }, @@ -24516,37 +23792,6 @@ }, "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": { @@ -25056,12 +24301,6 @@ "$ref": "#/components/schemas/ProductConfiguratorSetting" } }, - "productOpenGraphImages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, "orderLineItems": { "type": "array", "items": { @@ -27668,40 +26907,6 @@ "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": { @@ -28513,40 +27718,6 @@ "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)" @@ -33289,11 +32460,6 @@ "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": { @@ -33530,12 +32696,6 @@ "additionalProperties": false } }, - "ogTitle": { - "type": "string" - }, - "ogDescription": { - "type": "string" - }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -33878,36 +33038,6 @@ }, "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": { @@ -34692,11 +33822,6 @@ "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": { @@ -34933,12 +34058,6 @@ "additionalProperties": false } }, - "ogTitle": { - "type": "string" - }, - "ogDescription": { - "type": "string" - }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -35073,10 +34192,6 @@ "$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" }, @@ -36211,10 +35326,6 @@ "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" @@ -36480,10 +35591,6 @@ "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" @@ -39087,12 +38194,7 @@ "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", - "enum": [ - 10, - 20, - 30 - ] + "format": "int64" }, "createdAt": { "type": "string", @@ -39202,12 +38304,7 @@ "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", - "enum": [ - 10, - 20, - 30 - ] + "format": "int64" }, "createdAt": { "type": "string", @@ -42414,68 +41511,6 @@ }, "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": { @@ -43844,68 +42879,6 @@ }, "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": { @@ -44815,298 +43788,6 @@ }, "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": [ @@ -52124,20 +50805,6 @@ ], "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." } } }, @@ -56435,14 +55102,6 @@ "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 6faf772..0dc4311 100644 --- a/SwagDigitalSalesRooms-adminapi.summary.json +++ b/SwagDigitalSalesRooms-adminapi.summary.json @@ -20,6 +20,13 @@ "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics", + "/_action/media/{mediaId}/external-thumbnails", + "/_action/system-config", + "/_action/system-config/batch", + "/_action/system-config/check", + "/_action/system-config/schema", + "/_action/user/logout", + "/_action/validation/email", "/aggregate/dsr-appointment", "/aggregate/dsr-appointment-attendee", "/aggregate/dsr-appointment-request", @@ -29,8 +36,7 @@ "/aggregate/dsr-interaction", "/aggregate/dsr-presentation", "/aggregate/dsr-presentation-cms-page", - "/aggregate/sales-channel-tracking-customer", - "/aggregate/sales-channel-tracking-order", + "/app-system/shop/verify", "/dsr-appointment", "/dsr-appointment-attendee", "/dsr-appointment-attendee/{id}", @@ -49,10 +55,6 @@ "/dsr-presentation-cms-page", "/dsr-presentation-cms-page/{id}", "/dsr-presentation/{id}", - "/sales-channel-tracking-customer", - "/sales-channel-tracking-customer/{id}", - "/sales-channel-tracking-order", - "/sales-channel-tracking-order/{id}", "/search/dsr-appointment", "/search/dsr-appointment-attendee", "/search/dsr-appointment-request", @@ -61,9 +63,7 @@ "/search/dsr-cms-slide", "/search/dsr-interaction", "/search/dsr-presentation", - "/search/dsr-presentation-cms-page", - "/search/sales-channel-tracking-customer", - "/search/sales-channel-tracking-order" + "/search/dsr-presentation-cms-page" ], "schemas": [ "AbstractDynamicPageOpenedPayload", @@ -386,10 +386,6 @@ "SalesChannelLanguage", "SalesChannelPaymentMethod", "SalesChannelShippingMethod", - "SalesChannelTrackingCustomer", - "SalesChannelTrackingCustomerJsonApi", - "SalesChannelTrackingOrder", - "SalesChannelTrackingOrderJsonApi", "SalesChannelType", "SalesChannelTypeJsonApi", "Salutation", diff --git a/SwagGuidedShopping-adminapi.json b/SwagGuidedShopping-adminapi.json new file mode 100644 index 0000000..69369a7 --- /dev/null +++ b/SwagGuidedShopping-adminapi.json @@ -0,0 +1,40384 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Shopware Admin API", + "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.\n\nFor a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints\nadd the query parameter `type=jsonapi`.", + "license": { + "name": "MIT", + "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" + }, + "version": "6.6.6.1" + }, + "servers": [ + { + "url": "http://localhost:8000/api" + } + ], + "paths": [], + "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" + } + ] + }, + "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" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/error" + }, + "uniqueItems": true + } + }, + "type": "object", + "additionalProperties": false + }, + "info": { + "required": [ + "meta" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" + }, + "links": { + "$ref": "#/components/schemas/links" + }, + "jsonapi": { + "$ref": "#/components/schemas/jsonapi" + } + }, + "type": "object" + }, + "meta": { + "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", + "type": "object", + "additionalProperties": true + }, + "data": { + "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.", + "oneOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + ] + }, + "resource": { + "description": "\"Resource objects\" appear in a JSON API document to represent resources.", + "required": [ + "type", + "id" + ], + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "string" + }, + "attributes": { + "$ref": "#/components/schemas/attributes" + }, + "relationships": { + "$ref": "#/components/schemas/relationships" + }, + "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": true + }, + "links": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/link" + } + }, + "link": { + "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", + "oneOf": [ + { + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" + }, + { + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" + }, + "meta": { + "$ref": "#/components/schemas/meta" + } + } + } + ] + }, + "attributes": { + "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.", + "type": "object", + "additionalProperties": true + }, + "relationships": { + "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.", + "type": "object", + "anyOf": [ + { + "required": [ + "data" + ] + }, + { + "required": [ + "meta" + ] + }, + { + "required": [ + "links" + ] + }, + { + "type": "object", + "properties": { + "links": { + "$ref": "#/components/schemas/relationshipLinks" + }, + "data": { + "description": "Member, whose value represents \"resource linkage\".", + "oneOf": [ + { + "$ref": "#/components/schemas/relationshipToOne" + }, + { + "$ref": "#/components/schemas/relationshipToMany" + } + ] + } + } + } + ], + "additionalProperties": false + }, + "relationshipToOne": { + "allOf": [ + { + "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object." + }, + { + "$ref": "#/components/schemas/linkage" + } + ] + }, + "relationshipToMany": { + "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", + "type": "array", + "items": { + "$ref": "#/components/schemas/linkage" + }, + "uniqueItems": true + }, + "linkage": { + "description": "The \"type\" and \"id\" to non-empty members.", + "required": [ + "type", + "id" + ], + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "meta": { + "$ref": "#/components/schemas/meta" + } + }, + "type": "object", + "additionalProperties": false + }, + "pagination": { + "properties": { + "first": { + "description": "The first page of data", + "type": "string", + "format": "uri-reference" + }, + "last": { + "description": "The last page of data", + "type": "string", + "format": "uri-reference" + }, + "prev": { + "description": "The previous page of data", + "type": "string", + "format": "uri-reference" + }, + "next": { + "description": "The next page of data", + "type": "string", + "format": "uri-reference" + } + }, + "type": "object" + }, + "jsonapi": { + "description": "An object describing the server's implementation", + "properties": { + "version": { + "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", + "privileges", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privileges": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "users": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/users" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "example": "9bc65c2abec141778ffaa729489f3e87" + } + } + } + } + }, + "type": "object" + }, + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + }, + "integrations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/integrations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "example": "415320131958c70f4f250ca4d7e63bbd" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AclRole": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "privileges", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privileges": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "integrations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + }, + "type": "object" + }, + "AclUserRole": { + "description": "Added since version: 6.0.0.0", + "required": [ + "userId", + "aclRoleId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "user": { + "$ref": "#/components/schemas/User" + }, + "aclRole": { + "$ref": "#/components/schemas/AclRole" + } + }, + "type": "object" + }, + "AppJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "path", + "active", + "configurable", + "version", + "allowDisable", + "integrationId", + "aclRoleId", + "createdAt", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "author": { + "type": "string" + }, + "copyright": { + "type": "string" + }, + "license": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "configurable": { + "type": "boolean" + }, + "privacy": { + "type": "string" + }, + "version": { + "type": "string" + }, + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "modules": { + "type": "array", + "items": { + "type": "object" + } + }, + "mainModule": { + "type": "object" + }, + "cookies": { + "type": "array", + "items": { + "type": "object" + } + }, + "allowDisable": { + "type": "boolean" + }, + "baseAppUrl": { + "type": "string" + }, + "allowedHosts": { + "type": "array", + "items": { + "type": "string" + } + }, + "templateLoadPriority": { + "type": "integer", + "format": "int64" + }, + "checkoutGatewayUrl": { + "type": "string" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacyPolicyExtensions": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "integrationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "integration": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/integration" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "776ea3bf11df5829827f7afb43c37174" + } + } + } + }, + "type": "object" + }, + "aclRole": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/aclRole" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "acl_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "250aa1c64b973365fd6fd489eefbdefc" + } + } + } + }, + "type": "object" + }, + "customFieldSets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/customFieldSets" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set" + }, + "id": { + "type": "string", + "example": "9b29ba872ce510f033b31364c8602760" + } + } + } + } + }, + "type": "object" + }, + "actionButtons": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/actionButtons" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_action_button" + }, + "id": { + "type": "string", + "example": "2c7967427ed432e546ef1c0cb8d5da9e" + } + } + } + } + }, + "type": "object" + }, + "templates": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/templates" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_template" + }, + "id": { + "type": "string", + "example": "fed36e93a0509e20f2dc96cbbd85b678" + } + } + } + } + }, + "type": "object" + }, + "webhooks": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/webhooks" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "webhook" + }, + "id": { + "type": "string", + "example": "c10f40999b74c408263f790b30e70efe" + } + } + } + } + }, + "type": "object" + }, + "paymentMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/paymentMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_payment_method" + }, + "id": { + "type": "string", + "example": "b631b1ab565525e892f9cdc1242cca14" + } + } + } + } + }, + "type": "object" + }, + "taxProviders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/taxProviders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_provider" + }, + "id": { + "type": "string", + "example": "01a1a9d428b6402dc8255d99c787a00e" + } + } + } + } + }, + "type": "object" + }, + "cmsBlocks": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_cms_block" + }, + "id": { + "type": "string", + "example": "3636c4901eab836dfb837e1a9a37d3c0" + } + } + } + } + }, + "type": "object" + }, + "flowActions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowActions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_flow_action" + }, + "id": { + "type": "string", + "example": "8d83a8af9d1b8b85dae9bdb76b7dbe7f" + } + } + } + } + }, + "type": "object" + }, + "flowEvents": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowEvents" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_flow_event" + }, + "id": { + "type": "string", + "example": "045e9ec14eafd26d17854fb4fe7c9cae" + } + } + } + } + }, + "type": "object" + }, + "appShippingMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/appShippingMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_shipping_method" + }, + "id": { + "type": "string", + "example": "1ad05ee47064647ee5b2dc8c12b1041c" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "App": { + "description": "Added since version: 6.3.1.0", + "required": [ + "id", + "name", + "path", + "active", + "configurable", + "version", + "allowDisable", + "integrationId", + "aclRoleId", + "createdAt", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "author": { + "type": "string" + }, + "copyright": { + "type": "string" + }, + "license": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "configurable": { + "type": "boolean" + }, + "privacy": { + "type": "string" + }, + "version": { + "type": "string" + }, + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "modules": { + "type": "array", + "items": { + "type": "object" + } + }, + "mainModule": { + "type": "object" + }, + "cookies": { + "type": "array", + "items": { + "type": "object" + } + }, + "allowDisable": { + "type": "boolean" + }, + "baseAppUrl": { + "type": "string" + }, + "allowedHosts": { + "type": "array", + "items": { + "type": "string" + } + }, + "templateLoadPriority": { + "type": "integer", + "format": "int64" + }, + "checkoutGatewayUrl": { + "type": "string" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacyPolicyExtensions": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "integrationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "integration": { + "$ref": "#/components/schemas/Integration" + }, + "aclRole": { + "$ref": "#/components/schemas/AclRole" + }, + "customFieldSets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } + }, + "actionButtons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" + } + }, + "templates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } + }, + "webhooks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" + } + }, + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + }, + "taxProviders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + }, + "cmsBlocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } + }, + "flowActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } + }, + "flowEvents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } + }, + "appShippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + }, + "type": "object" + }, + "AppActionButtonJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "entity", + "view", + "url", + "action", + "appId", + "createdAt", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "type": "string" + }, + "view": { + "type": "string" + }, + "url": { + "type": "string" + }, + "action": { + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppActionButton": { + "description": "Added since version: 6.3.1.0", + "required": [ + "id", + "entity", + "view", + "url", + "action", + "appId", + "createdAt", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "type": "string" + }, + "view": { + "type": "string" + }, + "url": { + "type": "string" + }, + "action": { + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "AppAdministrationSnippetJsonApi": { + "description": "Added since version: 6.4.15.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "value", + "appId", + "localeId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "value": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "AppAdministrationSnippet": { + "description": "Added since version: 6.4.15.0", + "required": [ + "id", + "value", + "appId", + "localeId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "value": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "AppCmsBlockJsonApi": { + "description": "Added since version: 6.4.2.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "block", + "template", + "styles", + "appId", + "createdAt", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "block": { + "type": "object" + }, + "template": { + "type": "string" + }, + "styles": { + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppCmsBlock": { + "description": "Added since version: 6.4.2.0", + "required": [ + "id", + "name", + "block", + "template", + "styles", + "appId", + "createdAt", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "block": { + "type": "object" + }, + "template": { + "type": "string" + }, + "styles": { + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "AppFlowActionJsonApi": { + "description": "Added since version: 6.4.10.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "appId", + "name", + "url", + "createdAt", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "badge": { + "type": "string" + }, + "parameters": { + "type": "object" + }, + "config": { + "type": "object" + }, + "headers": { + "type": "object" + }, + "requirements": { + "type": "array", + "items": { + "type": "string" + } + }, + "iconRaw": { + "type": "string" + }, + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "swIcon": { + "type": "string" + }, + "url": { + "type": "string" + }, + "delayable": { + "type": "boolean" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "headline": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + }, + "flowSequences": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow_sequence" + }, + "id": { + "type": "string", + "example": "3a0d70b6dd3624074e5e15cd07e7fa90" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppFlowAction": { + "description": "Added since version: 6.4.10.0", + "required": [ + "id", + "appId", + "name", + "url", + "createdAt", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "badge": { + "type": "string" + }, + "parameters": { + "type": "object" + }, + "config": { + "type": "object" + }, + "headers": { + "type": "object" + }, + "requirements": { + "type": "array", + "items": { + "type": "string" + } + }, + "iconRaw": { + "type": "string" + }, + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "swIcon": { + "type": "string" + }, + "url": { + "type": "string" + }, + "delayable": { + "type": "boolean" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "headline": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "flowSequences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + } + }, + "type": "object" + }, + "AppFlowEventJsonApi": { + "description": "Added since version: 6.5.2.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "appId", + "name", + "aware", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "aware": { + "type": "array", + "items": { + "type": "string" + } + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + }, + "flows": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow" + }, + "id": { + "type": "string", + "example": "0db2dd944f9ee9a131f44b79d331d371" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppFlowEvent": { + "description": "Added since version: 6.5.2.0", + "required": [ + "id", + "appId", + "name", + "aware", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "aware": { + "type": "array", + "items": { + "type": "string" + } + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "flows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } + } + }, + "type": "object" + }, + "AppPaymentMethodJsonApi": { + "description": "Added since version: 6.4.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "appName", + "identifier", + "paymentMethodId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "payUrl": { + "type": "string" + }, + "finalizeUrl": { + "type": "string" + }, + "validateUrl": { + "type": "string" + }, + "captureUrl": { + "type": "string" + }, + "refundUrl": { + "type": "string" + }, + "recurringUrl": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + }, + "originalMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/originalMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "56386c66f82d9cd5639a5a7447971ead" + } + } + } + }, + "type": "object" + }, + "paymentMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/paymentMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppPaymentMethod": { + "description": "Added since version: 6.4.1.0", + "required": [ + "id", + "appName", + "identifier", + "paymentMethodId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "payUrl": { + "type": "string" + }, + "finalizeUrl": { + "type": "string" + }, + "validateUrl": { + "type": "string" + }, + "captureUrl": { + "type": "string" + }, + "refundUrl": { + "type": "string" + }, + "recurringUrl": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "originalMedia": { + "$ref": "#/components/schemas/Media" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + } + }, + "type": "object" + }, + "AppScriptConditionJsonApi": { + "description": "Added since version: 6.4.10.3", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "identifier", + "active", + "appId", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "type": "string" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "group": { + "type": "string" + }, + "script": { + "type": "string" + }, + "config": { + "type": "object" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + }, + "ruleConditions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/ruleConditions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule_condition" + }, + "id": { + "type": "string", + "example": "24bfabce4195894c9aed9b8bcfb0b748" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppScriptCondition": { + "description": "Added since version: 6.4.10.3", + "required": [ + "id", + "identifier", + "active", + "appId", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "type": "string" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "group": { + "type": "string" + }, + "script": { + "type": "string" + }, + "config": { + "type": "object" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "ruleConditions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + }, + "type": "object" + }, + "AppShippingMethodJsonApi": { + "description": "Added since version: 6.5.7.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "appName", + "identifier", + "shippingMethodId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + }, + "shippingMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/shippingMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + } + } + } + }, + "type": "object" + }, + "originalMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/originalMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "56386c66f82d9cd5639a5a7447971ead" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppShippingMethod": { + "description": "Added since version: 6.5.7.0", + "required": [ + "id", + "appName", + "identifier", + "shippingMethodId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "originalMedia": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "AppTemplateJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "template", + "path", + "active", + "appId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "template": { + "type": "string" + }, + "path": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-template/ca9106b8b82ff55b6fdce530ccb952a7/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppTemplate": { + "description": "Added since version: 6.3.1.0", + "required": [ + "id", + "template", + "path", + "active", + "appId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "template": { + "type": "string" + }, + "path": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "CategoryJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "displayNestedProducts", + "type", + "productAssignmentType", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "displayNestedProducts": { + "type": "boolean" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "breadcrumb": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "readOnly": true + }, + "level": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "type": "string", + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "type": { + "type": "string" + }, + "productAssignmentType": { + "type": "string" + }, + "visible": { + "type": "boolean" + }, + "active": { + "type": "boolean" + }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "visibleChildCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "linkType": { + "type": "string" + }, + "internalLink": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalLink": { + "type": "string" + }, + "linkNewTab": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "metaTitle": { + "type": "string" + }, + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customEntityTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "parent": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "children": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/children" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + }, + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + }, + "nestedProducts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/nestedProducts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "cf73cebf9ade7f94deba94ec71e66e43" + } + } + } + } + }, + "type": "object" + }, + "tags": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "cmsPage": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/cmsPage" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7b1460918b1abb93311108f3dc021c9b" + } + } + } + }, + "type": "object" + }, + "productStream": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/productStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "49561f6faa0badfce831a183d2ec7c2f" + } + } + } + }, + "type": "object" + }, + "navigationSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/navigationSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "04db458d860e0a4b455ae14b384a5e8a" + } + } + } + } + }, + "type": "object" + }, + "footerSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/footerSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "57944aba1f6dea7ca9dacf66776e1755" + } + } + } + } + }, + "type": "object" + }, + "serviceSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/serviceSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "1a79932fadba3b20baf6369181e45602" + } + } + } + } + }, + "type": "object" + }, + "mainCategories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/mainCategories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "main_category" + }, + "id": { + "type": "string", + "example": "1fb731fc4139cbb575429e28846f0c39" + } + } + } + } + }, + "type": "object" + }, + "seoUrls": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/seoUrls" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "seo_url" + }, + "id": { + "type": "string", + "example": "5321b5a71127b8b98cdd4b068ad56c4c" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Category": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "displayNestedProducts", + "type", + "productAssignmentType", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "displayNestedProducts": { + "type": "boolean" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "breadcrumb": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "readOnly": true + }, + "level": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "type": "string", + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "type": { + "type": "string" + }, + "productAssignmentType": { + "type": "string" + }, + "visible": { + "type": "boolean" + }, + "active": { + "type": "boolean" + }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "visibleChildCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "linkType": { + "type": "string" + }, + "internalLink": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalLink": { + "type": "string" + }, + "linkNewTab": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "metaTitle": { + "type": "string" + }, + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customEntityTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "parent": { + "$ref": "#/components/schemas/Category" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "nestedProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + }, + "navigationSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "footerSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "serviceSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "mainCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + }, + "seoUrls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + }, + "type": "object" + }, + "CategoryTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "categoryId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "category": { + "$ref": "#/components/schemas/Category" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "CmsBlockJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "position", + "type", + "sectionId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "sectionPosition": { + "type": "string" + }, + "marginTop": { + "type": "string" + }, + "marginBottom": { + "type": "string" + }, + "marginLeft": { + "type": "string" + }, + "marginRight": { + "type": "string" + }, + "backgroundColor": { + "type": "string" + }, + "backgroundMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "type": "string" + }, + "cssClass": { + "type": "string" + }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "sectionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "section": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/section" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_section" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "73d5342eba070f636ac3246f319bf77f" + } + } + } + }, + "type": "object" + }, + "backgroundMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/backgroundMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9f63714a30b4d0292695bd4d27235a0b" + } + } + } + }, + "type": "object" + }, + "slots": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/slots" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_slot" + }, + "id": { + "type": "string", + "example": "a8b72798beb911ae98c8c8907d45950a" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CmsBlock": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "position", + "type", + "sectionId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "sectionPosition": { + "type": "string" + }, + "marginTop": { + "type": "string" + }, + "marginBottom": { + "type": "string" + }, + "marginLeft": { + "type": "string" + }, + "marginRight": { + "type": "string" + }, + "backgroundColor": { + "type": "string" + }, + "backgroundMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "type": "string" + }, + "cssClass": { + "type": "string" + }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "sectionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "section": { + "$ref": "#/components/schemas/CmsSection" + }, + "backgroundMedia": { + "$ref": "#/components/schemas/Media" + }, + "slots": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } + } + }, + "type": "object" + }, + "CmsPageJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "type", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "entity": { + "type": "string" + }, + "cssClass": { + "type": "string" + }, + "config": { + "properties": { + "backgroundColor": { + "type": "string" + } + }, + "type": "object" + }, + "previewMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "locked": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "sections": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/sections" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_section" + }, + "id": { + "type": "string", + "example": "ff4dee88db82e98f0e0d524d965b9aa7" + } + } + } + } + }, + "type": "object" + }, + "previewMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/previewMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a7a817fb0e422cff87e878b8ff7ca914" + } + } + } + }, + "type": "object" + }, + "categories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/categories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" + } + } + } + } + }, + "type": "object" + }, + "landingPages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/landingPages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "landing_page" + }, + "id": { + "type": "string", + "example": "d60b77f2b3bd69591e3d5e3100926b4d" + } + } + } + } + }, + "type": "object" + }, + "homeSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/homeSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "9aed0c38161f67f2d40a4a872cae045f" + } + } + } + } + }, + "type": "object" + }, + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CmsPage": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "type", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "entity": { + "type": "string" + }, + "cssClass": { + "type": "string" + }, + "config": { + "properties": { + "backgroundColor": { + "type": "string" + } + }, + "type": "object" + }, + "previewMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "locked": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "sections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + }, + "previewMedia": { + "$ref": "#/components/schemas/Media" + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "landingPages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + }, + "homeSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + }, + "type": "object" + }, + "CmsSectionJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "position", + "type", + "pageId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "sizingMode": { + "type": "string" + }, + "mobileBehavior": { + "type": "string" + }, + "backgroundColor": { + "type": "string" + }, + "backgroundMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "type": "string" + }, + "cssClass": { + "type": "string" + }, + "pageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "page": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/page" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "71860c77c6745379b0d44304d66b6a13" + } + } + } + }, + "type": "object" + }, + "backgroundMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/backgroundMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9f63714a30b4d0292695bd4d27235a0b" + } + } + } + }, + "type": "object" + }, + "blocks": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/blocks" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_block" + }, + "id": { + "type": "string", + "example": "e734964953f880e5164e32827950ff92" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CmsSection": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "position", + "type", + "pageId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "sizingMode": { + "type": "string" + }, + "mobileBehavior": { + "type": "string" + }, + "backgroundColor": { + "type": "string" + }, + "backgroundMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "type": "string" + }, + "cssClass": { + "type": "string" + }, + "pageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "page": { + "$ref": "#/components/schemas/CmsPage" + }, + "backgroundMedia": { + "$ref": "#/components/schemas/Media" + }, + "blocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + } + }, + "type": "object" + }, + "CmsSlotJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "type", + "slot", + "blockId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "slot": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "config": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "data": { + "type": "object", + "readOnly": true + }, + "blockId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "block": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/block" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_block" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "14511f2f5564650d129ca7cabc333278" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CmsSlot": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "type", + "slot", + "blockId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "slot": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "config": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "data": { + "type": "object", + "readOnly": true + }, + "blockId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "block": { + "$ref": "#/components/schemas/CmsBlock" + } + }, + "type": "object" + }, + "CountryJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "isEu", + "createdAt", + "name", + "addressFormat" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "iso": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "shippingAvailable": { + "type": "boolean" + }, + "iso3": { + "type": "string" + }, + "displayStateInRegistration": { + "type": "boolean" + }, + "forceStateInRegistration": { + "type": "boolean" + }, + "checkVatIdPattern": { + "type": "boolean" + }, + "vatIdRequired": { + "type": "boolean" + }, + "vatIdPattern": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "companyTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "postalCodeRequired": { + "type": "boolean" + }, + "checkPostalCodePattern": { + "type": "boolean" + }, + "checkAdvancedPostalCodePattern": { + "type": "boolean" + }, + "advancedPostalCodePattern": { + "type": "string" + }, + "addressFormat": { + "type": "object" + }, + "defaultPostalCodePattern": { + "type": "string" + }, + "isEu": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "states": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/states" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country_state" + }, + "id": { + "type": "string", + "example": "34d955a0df5f7af9c9b4e4dccb3c3564" + } + } + } + } + }, + "type": "object" + }, + "customerAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/customerAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "example": "84ed5cbc10cd9f665a8c9f05e49095af" + } + } + } + } + }, + "type": "object" + }, + "orderAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/orderAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "example": "c3182f0dc0cc20b4982616d3e0221747" + } + } + } + } + }, + "type": "object" + }, + "salesChannelDefaultAssignments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannelDefaultAssignments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "b23663b2abc0909be9a8027a3fbff74b" + } + } + } + } + }, + "type": "object" + }, + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + } + }, + "type": "object" + }, + "taxRules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/taxRules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_rule" + }, + "id": { + "type": "string", + "example": "1b93ada511aac379c19d3afcba4e4041" + } + } + } + } + }, + "type": "object" + }, + "currencyCountryRoundings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/currencyCountryRoundings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency_country_rounding" + }, + "id": { + "type": "string", + "example": "35ef8dd5459bf5f08d44cb278bf07cd4" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Country": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "isEu", + "createdAt", + "name", + "addressFormat" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "iso": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "shippingAvailable": { + "type": "boolean" + }, + "iso3": { + "type": "string" + }, + "displayStateInRegistration": { + "type": "boolean" + }, + "forceStateInRegistration": { + "type": "boolean" + }, + "checkVatIdPattern": { + "type": "boolean" + }, + "vatIdRequired": { + "type": "boolean" + }, + "vatIdPattern": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "companyTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "postalCodeRequired": { + "type": "boolean" + }, + "checkPostalCodePattern": { + "type": "boolean" + }, + "checkAdvancedPostalCodePattern": { + "type": "boolean" + }, + "advancedPostalCodePattern": { + "type": "string" + }, + "addressFormat": { + "type": "object" + }, + "defaultPostalCodePattern": { + "type": "string" + }, + "isEu": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "states": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } + }, + "customerAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + }, + "orderAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + }, + "salesChannelDefaultAssignments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "taxRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + }, + "currencyCountryRoundings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + }, + "type": "object" + }, + "CountryStateJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "countryId", + "shortCode", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shortCode": { + "type": "string" + }, + "name": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "country": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/country" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" + } + } + } + }, + "type": "object" + }, + "customerAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/customerAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "example": "84ed5cbc10cd9f665a8c9f05e49095af" + } + } + } + } + }, + "type": "object" + }, + "orderAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/orderAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "example": "c3182f0dc0cc20b4982616d3e0221747" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CountryState": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "countryId", + "shortCode", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shortCode": { + "type": "string" + }, + "name": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "customerAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + }, + "orderAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + } + }, + "type": "object" + }, + "CurrencyJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "factor", + "symbol", + "isoCode", + "itemRounding", + "totalRounding", + "createdAt", + "shortName", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "factor": { + "type": "number", + "format": "float" + }, + "symbol": { + "type": "string" + }, + "isoCode": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "taxFreeFrom": { + "type": "number", + "format": "float" + }, + "customFields": { + "type": "object" + }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "salesChannelDefaultAssignments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDefaultAssignments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "b23663b2abc0909be9a8027a3fbff74b" + } + } + } + } + }, + "type": "object" + }, + "orders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/orders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "example": "12c500ed0b7879105fb46af0f246be87" + } + } + } + } + }, + "type": "object" + }, + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + } + }, + "type": "object" + }, + "salesChannelDomains": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDomains" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_domain" + }, + "id": { + "type": "string", + "example": "b60ab8d110194bfe34ef9928ba48ab6d" + } + } + } + } + }, + "type": "object" + }, + "promotionDiscountPrices": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/promotionDiscountPrices" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion_discount_prices" + }, + "id": { + "type": "string", + "example": "325723473ecab76b0f45e1554513f779" + } + } + } + } + }, + "type": "object" + }, + "productExports": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/productExports" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_export" + }, + "id": { + "type": "string", + "example": "2cd8793787cda582174c0fc329fbc377" + } + } + } + } + }, + "type": "object" + }, + "countryRoundings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/countryRoundings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency_country_rounding" + }, + "id": { + "type": "string", + "example": "3de4aa80c8c8822ea10d156a6f58d6f7" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Currency": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "factor", + "symbol", + "isoCode", + "itemRounding", + "totalRounding", + "createdAt", + "shortName", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "factor": { + "type": "number", + "format": "float" + }, + "symbol": { + "type": "string" + }, + "isoCode": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "taxFreeFrom": { + "type": "number", + "format": "float" + }, + "customFields": { + "type": "object" + }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "salesChannelDefaultAssignments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "orders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "salesChannelDomains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + }, + "promotionDiscountPrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + }, + "productExports": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + }, + "countryRoundings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + }, + "type": "object" + }, + "CurrencyCountryRoundingJsonApi": { + "description": "Added since version: 6.4.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "currencyId", + "countryId", + "itemRounding", + "totalRounding", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "currency": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/currency" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" + } + } + } + }, + "type": "object" + }, + "country": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/country" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CurrencyCountryRounding": { + "description": "Added since version: 6.4.0.0", + "required": [ + "id", + "currencyId", + "countryId", + "itemRounding", + "totalRounding", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "country": { + "$ref": "#/components/schemas/Country" + } + }, + "type": "object" + }, + "CustomEntityJsonApi": { + "description": "Added since version: 6.4.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "fields", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "fields": { + "type": "object" + }, + "flags": { + "type": "object" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pluginId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "storeApiAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "customFieldsAware": { + "type": "boolean" + }, + "labelProperty": { + "type": "string" + }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "CustomEntity": { + "description": "Added since version: 6.4.9.0", + "required": [ + "id", + "name", + "fields", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "fields": { + "type": "object" + }, + "flags": { + "type": "object" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pluginId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "storeApiAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "customFieldsAware": { + "type": "boolean" + }, + "labelProperty": { + "type": "string" + }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "CustomFieldJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "type", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "type": "boolean" + }, + "customFieldSetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "allowCustomerWrite": { + "type": "boolean" + }, + "allowCartExpose": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customFieldSet": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/customFieldSet" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "df17e58b74fa5cb09c5e84f3b37141e1" + } + } + } + }, + "type": "object" + }, + "productSearchConfigFields": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/productSearchConfigFields" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_config_field" + }, + "id": { + "type": "string", + "example": "ae6a70432f71d6905502769f184399b1" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomField": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "type", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "type": "boolean" + }, + "customFieldSetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "allowCustomerWrite": { + "type": "boolean" + }, + "allowCartExpose": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFieldSet": { + "$ref": "#/components/schemas/CustomFieldSet" + }, + "productSearchConfigFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + }, + "type": "object" + }, + "CustomFieldSetJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "type": "boolean" + }, + "global": { + "type": "boolean" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customFields": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/customFields" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field" + }, + "id": { + "type": "string", + "example": "4e252ff73243c27b4df9002e452fc6a7" + } + } + } + } + }, + "type": "object" + }, + "relations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/relations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set_relation" + }, + "id": { + "type": "string", + "example": "06c5b10273a69992d8c6933e294909fa" + } + } + } + } + }, + "type": "object" + }, + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + }, + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomFieldSet": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "type": "boolean" + }, + "global": { + "type": "boolean" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } + }, + "relations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "CustomFieldSetRelationJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customFieldSetId", + "entityName", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFieldSetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityName": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customFieldSet": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field-set-relation/9686e510825802f328b6a861ccaa977e/customFieldSet" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "df17e58b74fa5cb09c5e84f3b37141e1" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomFieldSetRelation": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "customFieldSetId", + "entityName", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFieldSetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityName": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFieldSet": { + "$ref": "#/components/schemas/CustomFieldSet" + } + }, + "type": "object" + }, + "CustomerJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "groupId", + "salesChannelId", + "languageId", + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", + "firstName", + "lastName", + "email", + "accountType", + "defaultPaymentMethodId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "groupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "lastPaymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultBillingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultShippingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customerNumber": { + "type": "string" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "company": { + "type": "string" + }, + "email": { + "type": "string" + }, + "title": { + "type": "string" + }, + "vatIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "affiliateCode": { + "type": "string" + }, + "campaignCode": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "doubleOptInRegistration": { + "type": "boolean" + }, + "doubleOptInEmailSentDate": { + "type": "string", + "format": "date-time" + }, + "doubleOptInConfirmDate": { + "type": "string", + "format": "date-time" + }, + "hash": { + "type": "string" + }, + "guest": { + "type": "boolean" + }, + "firstLogin": { + "type": "string", + "format": "date-time" + }, + "lastLogin": { + "type": "string", + "format": "date-time" + }, + "birthday": { + "type": "string" + }, + "lastOrderDate": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "orderCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderTotalAmount": { + "type": "number", + "format": "float", + "readOnly": true + }, + "reviewCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "remoteAddress": { + "type": "string" + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "requestedGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "boundSalesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "accountType": { + "type": "string" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultPaymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "group": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/group" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "db0f6f37ebeb6ea09489124345af2a45" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "language": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" + } + } + } + }, + "type": "object" + }, + "lastPaymentMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/lastPaymentMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bb083200005a374b86f6f5fbbff6f0e0" + } + } + } + }, + "type": "object" + }, + "defaultBillingAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultBillingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "263d0f6e5d8d71fc4c288736f7c90990" + } + } + } + }, + "type": "object" + }, + "defaultShippingAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultShippingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8218c377171d06883caea7e2baf67f31" + } + } + } + }, + "type": "object" + }, + "salutation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salutation" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "salutation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + } + } + } + }, + "type": "object" + }, + "addresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/addresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "example": "963e3a2fe559e393bad631f3dc686f69" + } + } + } + } + }, + "type": "object" + }, + "orderCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/orderCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_customer" + }, + "id": { + "type": "string", + "example": "1e7dbe7e3bcb48d233fd80588f54c980" + } + } + } + } + }, + "type": "object" + }, + "tags": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "promotions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/promotions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "example": "ea6aeb050f871384f25fba9c869cfe21" + } + } + } + } + }, + "type": "object" + }, + "productReviews": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/productReviews" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review" + }, + "id": { + "type": "string", + "example": "01e78541ea343ed72424a5222796a4cd" + } + } + } + } + }, + "type": "object" + }, + "recoveryCustomer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/recoveryCustomer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_recovery" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ce9d8d13e51bf43bc70a4be38950823b" + } + } + } + }, + "type": "object" + }, + "requestedGroup": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/requestedGroup" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "46cf25a3f20102ff5e1e17526fb73b62" + } + } + } + }, + "type": "object" + }, + "boundSalesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/boundSalesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "dfe8aec35136b1f62669b388a291a4c7" + } + } + } + }, + "type": "object" + }, + "wishlists": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/wishlists" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_wishlist" + }, + "id": { + "type": "string", + "example": "4ec38c6b2208529c1fadccc7d55d7947" + } + } + } + } + }, + "type": "object" + }, + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/createdBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" + } + } + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/updatedBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" + } + } + } + }, + "type": "object" + }, + "defaultPaymentMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultPaymentMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8f35e31802b72bf010a333999b26f3a6" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Customer": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "groupId", + "salesChannelId", + "languageId", + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", + "firstName", + "lastName", + "email", + "accountType", + "defaultPaymentMethodId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "groupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "lastPaymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultBillingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultShippingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customerNumber": { + "type": "string" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "company": { + "type": "string" + }, + "email": { + "type": "string" + }, + "title": { + "type": "string" + }, + "vatIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "affiliateCode": { + "type": "string" + }, + "campaignCode": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "doubleOptInRegistration": { + "type": "boolean" + }, + "doubleOptInEmailSentDate": { + "type": "string", + "format": "date-time" + }, + "doubleOptInConfirmDate": { + "type": "string", + "format": "date-time" + }, + "hash": { + "type": "string" + }, + "guest": { + "type": "boolean" + }, + "firstLogin": { + "type": "string", + "format": "date-time" + }, + "lastLogin": { + "type": "string", + "format": "date-time" + }, + "birthday": { + "type": "string" + }, + "lastOrderDate": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "orderCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderTotalAmount": { + "type": "number", + "format": "float", + "readOnly": true + }, + "reviewCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "remoteAddress": { + "type": "string" + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "requestedGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "boundSalesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "accountType": { + "type": "string" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultPaymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "group": { + "$ref": "#/components/schemas/CustomerGroup" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "lastPaymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + }, + "defaultBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "defaultShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + }, + "addresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + }, + "orderCustomers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "promotions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + }, + "productReviews": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + }, + "recoveryCustomer": { + "$ref": "#/components/schemas/CustomerRecovery" + }, + "requestedGroup": { + "$ref": "#/components/schemas/CustomerGroup" + }, + "boundSalesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "wishlists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + }, + "defaultPaymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + } + }, + "type": "object" + }, + "CustomerAddressJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "zipcode": { + "type": "string" + }, + "city": { + "type": "string" + }, + "company": { + "type": "string" + }, + "street": { + "type": "string" + }, + "department": { + "type": "string" + }, + "title": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "additionalAddressLine1": { + "type": "string" + }, + "additionalAddressLine2": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "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": "/customer-address/1b4b031005f93d02d887e7d66efb653b/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "country": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" + } + } + } + }, + "type": "object" + }, + "countryState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "cb6a9764567191fb74fe28d8d6a4819d" + } + } + } + }, + "type": "object" + }, + "salutation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "salutation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomerAddress": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "zipcode": { + "type": "string" + }, + "city": { + "type": "string" + }, + "company": { + "type": "string" + }, + "street": { + "type": "string" + }, + "department": { + "type": "string" + }, + "title": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "additionalAddressLine1": { + "type": "string" + }, + "additionalAddressLine2": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + } + }, + "type": "object" + }, + "CustomerGroupJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "displayGross": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "registrationActive": { + "type": "boolean" + }, + "registrationTitle": { + "type": "string" + }, + "registrationIntroduction": { + "type": "string" + }, + "registrationOnlyCompanyRegistration": { + "type": "boolean" + }, + "registrationSeoMetaDescription": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "customers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "4b6f7d34a58ba399f077685951d06738" + } + } + } + } + }, + "type": "object" + }, + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + } + }, + "type": "object" + }, + "registrationSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/registrationSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "ffc8e76c1fe257d563b9d0024a50620b" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomerGroup": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "displayGross": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "registrationActive": { + "type": "boolean" + }, + "registrationTitle": { + "type": "string" + }, + "registrationIntroduction": { + "type": "string" + }, + "registrationOnlyCompanyRegistration": { + "type": "boolean" + }, + "registrationSeoMetaDescription": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "customers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "registrationSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + }, + "type": "object" + }, + "CustomerGroupRegistrationSalesChannels": { + "description": "Added since version: 6.3.1.0", + "required": [ + "customerGroupId", + "salesChannelId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customerGroup": { + "$ref": "#/components/schemas/CustomerGroup" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "CustomerRecoveryJsonApi": { + "description": "Added since version: 6.1.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "hash", + "customerId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "type": "string" + }, + "customerId": { + "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": "/customer-recovery/5c91cd3c845f51250c566f72e5fec3bf/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomerRecovery": { + "description": "Added since version: 6.1.0.0", + "required": [ + "id", + "hash", + "customerId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "type": "string" + }, + "customerId": { + "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" + } + }, + "type": "object" + }, + "CustomerTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "customerId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "CustomerWishlistJsonApi": { + "description": "Added since version: 6.3.4.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customerId", + "salesChannelId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_wishlist_product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + }, + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/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": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/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" + } + ] + }, + "CustomerWishlist": { + "description": "Added since version: 6.3.4.0", + "required": [ + "id", + "customerId", + "salesChannelId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "CustomerWishlistProductJsonApi": { + "description": "Added since version: 6.3.4.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "wishlistId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "wishlistId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "wishlist": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/wishlist" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_wishlist" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "723edf7c24638ed18d2fa831e647a5cc" + } + } + } + }, + "type": "object" + }, + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomerWishlistProduct": { + "description": "Added since version: 6.3.4.0", + "required": [ + "id", + "productId", + "wishlistId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "wishlistId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "wishlist": { + "$ref": "#/components/schemas/CustomerWishlist" + }, + "product": { + "$ref": "#/components/schemas/Product" + } + }, + "type": "object" + }, + "DeliveryTimeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "min", + "max", + "unit", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "min": { + "type": "integer", + "format": "int64" + }, + "max": { + "type": "integer", + "format": "int64" + }, + "unit": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "shippingMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/shippingMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "example": "8268b0a6c902fbde485094c2f627b854" + } + } + } + } + }, + "type": "object" + }, + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DeliveryTime": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "min", + "max", + "unit", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "min": { + "type": "integer", + "format": "int64" + }, + "max": { + "type": "integer", + "format": "int64" + }, + "unit": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "shippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + }, + "type": "object" + }, + "DocumentJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "documentTypeId", + "fileType", + "orderId", + "config", + "deepLinkCode", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fileType": { + "type": "string" + }, + "referencedDocumentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "config": { + "type": "object" + }, + "sent": { + "type": "boolean" + }, + "static": { + "type": "boolean" + }, + "deepLinkCode": { + "type": "string" + }, + "documentNumber": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "documentType": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentType" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2e45fec65781ec559e2aea39372a55cd" + } + } + } + }, + "type": "object" + }, + "order": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/order" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "referencedDocument": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/referencedDocument" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "75c3c346b0ef4f319e71925ce164a9ae" + } + } + } + }, + "type": "object" + }, + "dependentDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/dependentDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "example": "e74b269b7d5f269051463569677da2a0" + } + } + } + } + }, + "type": "object" + }, + "documentMediaFile": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentMediaFile" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ac7db1e6be481d6422fc63700e08279d" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Document": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "documentTypeId", + "fileType", + "orderId", + "config", + "deepLinkCode", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fileType": { + "type": "string" + }, + "referencedDocumentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "config": { + "type": "object" + }, + "sent": { + "type": "boolean" + }, + "static": { + "type": "boolean" + }, + "deepLinkCode": { + "type": "string" + }, + "documentNumber": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "documentType": { + "$ref": "#/components/schemas/DocumentType" + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "referencedDocument": { + "$ref": "#/components/schemas/Document" + }, + "dependentDocuments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, + "documentMediaFile": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "DocumentBaseConfigJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "documentTypeId", + "name", + "global", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "logoId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "filenamePrefix": { + "type": "string" + }, + "filenameSuffix": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "documentNumber": { + "type": "string" + }, + "config": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "documentType": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/documentType" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2e45fec65781ec559e2aea39372a55cd" + } + } + } + }, + "type": "object" + }, + "logo": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/logo" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "96d6f2e7e1f705ab5e59c84a6dc009b2" + } + } + } + }, + "type": "object" + }, + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config_sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DocumentBaseConfig": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "documentTypeId", + "name", + "global", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "logoId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "filenamePrefix": { + "type": "string" + }, + "filenameSuffix": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "documentNumber": { + "type": "string" + }, + "config": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "documentType": { + "$ref": "#/components/schemas/DocumentType" + }, + "logo": { + "$ref": "#/components/schemas/Media" + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + }, + "type": "object" + }, + "DocumentBaseConfigSalesChannelJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "documentBaseConfigId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentBaseConfigId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "documentType": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentType" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2e45fec65781ec559e2aea39372a55cd" + } + } + } + }, + "type": "object" + }, + "documentBaseConfig": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentBaseConfig" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "56e59df02965ebf8eadea49fa0aadd47" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DocumentBaseConfigSalesChannel": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "documentBaseConfigId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentBaseConfigId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "documentType": { + "$ref": "#/components/schemas/DocumentType" + }, + "documentBaseConfig": { + "$ref": "#/components/schemas/DocumentBaseConfig" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "DocumentTypeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "technicalName", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "technicalName": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "documents": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documents" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "example": "21f64da1e5792c8295b964d159a14491" + } + } + } + } + }, + "type": "object" + }, + "documentBaseConfigs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config" + }, + "id": { + "type": "string", + "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" + } + } + } + } + }, + "type": "object" + }, + "documentBaseConfigSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config_sales_channel" + }, + "id": { + "type": "string", + "example": "9c990fde5b38ff70fc1a07bf84c12a17" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DocumentType": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "technicalName", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "technicalName": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "translated": { + "type": "object" + }, + "documents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, + "documentBaseConfigs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + }, + "documentBaseConfigSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + }, + "type": "object" + }, + "FlowJsonApi": { + "description": "Added since version: 6.4.6.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "eventName", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "eventName": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "invalid": { + "type": "boolean", + "readOnly": true + }, + "active": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "appFlowEventId": { + "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": { + "sequences": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/sequences" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow_sequence" + }, + "id": { + "type": "string", + "example": "eb6710ddc89dae357ae94ca3974b1e38" + } + } + } + } + }, + "type": "object" + }, + "appFlowEvent": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/appFlowEvent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_flow_event" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d92d404135abc21e31337d9509cbe62f" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Flow": { + "description": "Added since version: 6.4.6.0", + "required": [ + "id", + "name", + "eventName", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "eventName": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "invalid": { + "type": "boolean", + "readOnly": true + }, + "active": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "appFlowEventId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "sequences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + }, + "appFlowEvent": { + "$ref": "#/components/schemas/AppFlowEvent" + } + }, + "type": "object" + }, + "FlowSequenceJsonApi": { + "description": "Added since version: 6.4.6.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "flowId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "flowId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionName": { + "type": "string" + }, + "config": { + "type": "object" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "displayGroup": { + "type": "integer", + "format": "int64" + }, + "trueCase": { + "type": "boolean" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "appFlowActionId": { + "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": { + "flow": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/flow" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "cff5497121104c2b8e0cb41ed2083a9b" + } + } + } + }, + "type": "object" + }, + "rule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/rule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "981c1e7b3795da18687613fbd66d4954" + } + } + } + }, + "type": "object" + }, + "parent": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow_sequence" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "children": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/children" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow_sequence" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } + } + } + } + }, + "type": "object" + }, + "appFlowAction": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/appFlowAction" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_flow_action" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8ba9ae8a60ecf9be421e333b95703a68" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "FlowSequence": { + "description": "Added since version: 6.4.6.0", + "required": [ + "id", + "flowId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "flowId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionName": { + "type": "string" + }, + "config": { + "type": "object" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "displayGroup": { + "type": "integer", + "format": "int64" + }, + "trueCase": { + "type": "boolean" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "appFlowActionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "flow": { + "$ref": "#/components/schemas/Flow" + }, + "rule": { + "$ref": "#/components/schemas/Rule" + }, + "parent": { + "$ref": "#/components/schemas/FlowSequence" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + }, + "appFlowAction": { + "$ref": "#/components/schemas/AppFlowAction" + } + }, + "type": "object" + }, + "FlowTemplateJsonApi": { + "description": "Added since version: 6.4.18.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "config": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "FlowTemplate": { + "description": "Added since version: 6.4.18.0", + "required": [ + "id", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "config": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ImportExportFileJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "originalName", + "path", + "expireDate", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalName": { + "type": "string" + }, + "path": { + "type": "string" + }, + "expireDate": { + "type": "string", + "format": "date-time" + }, + "size": { + "type": "integer", + "format": "int64" + }, + "accessToken": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "log": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/import-export-file/1e0a4283354a721dbed68499ce2db333/log" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "import_export_log" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "dc1d71bbb5c4d2a5e936db79ef10c19f" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ImportExportFile": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "originalName", + "path", + "expireDate", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalName": { + "type": "string" + }, + "path": { + "type": "string" + }, + "expireDate": { + "type": "string", + "format": "date-time" + }, + "size": { + "type": "integer", + "format": "int64" + }, + "accessToken": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "log": { + "$ref": "#/components/schemas/ImportExportLog" + } + }, + "type": "object" + }, + "ImportExportLogJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "activity", + "state", + "records", + "config", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "activity": { + "type": "string" + }, + "state": { + "type": "string" + }, + "records": { + "type": "integer", + "format": "int64" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "profileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "invalidRecordsLogId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "username": { + "type": "string" + }, + "profileName": { + "type": "string" + }, + "config": { + "type": "object" + }, + "result": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "user": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/user" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ee11cbb19052e40b07aac0ca060c23ee" + } + } + } + }, + "type": "object" + }, + "profile": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/profile" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "import_export_profile" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7d97481b1fe66f4b51db90da7e794d9f" + } + } + } + }, + "type": "object" + }, + "file": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/file" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "import_export_file" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8c7dd922ad47494fc02c388e12c00eac" + } + } + } + }, + "type": "object" + }, + "invalidRecordsLog": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/invalidRecordsLog" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "import_export_log" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "46eeeb74b58b97a6a05494fa0024c998" + } + } + } + }, + "type": "object" + }, + "failedImportLog": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/failedImportLog" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "import_export_log" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1d6996fa1560fc40e5faad086b07ad18" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ImportExportLog": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "activity", + "state", + "records", + "config", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "activity": { + "type": "string" + }, + "state": { + "type": "string" + }, + "records": { + "type": "integer", + "format": "int64" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "profileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "invalidRecordsLogId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "username": { + "type": "string" + }, + "profileName": { + "type": "string" + }, + "config": { + "type": "object" + }, + "result": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "user": { + "$ref": "#/components/schemas/User" + }, + "profile": { + "$ref": "#/components/schemas/ImportExportProfile" + }, + "file": { + "$ref": "#/components/schemas/ImportExportFile" + }, + "invalidRecordsLog": { + "$ref": "#/components/schemas/ImportExportLog" + }, + "failedImportLog": { + "$ref": "#/components/schemas/ImportExportLog" + } + }, + "type": "object" + }, + "ImportExportProfileJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "label", + "sourceEntity", + "fileType", + "delimiter", + "enclosure", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "label": { + "type": "string" + }, + "type": { + "type": "string" + }, + "systemDefault": { + "type": "boolean" + }, + "sourceEntity": { + "type": "string" + }, + "fileType": { + "type": "string" + }, + "delimiter": { + "type": "string" + }, + "enclosure": { + "type": "string" + }, + "mapping": { + "type": "object" + }, + "updateBy": { + "type": "object" + }, + "config": { + "type": "object" + }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "importExportLogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/import-export-profile/59e9b5cef4e569ce1af9aaa1d37135fc/importExportLogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "import_export_log" + }, + "id": { + "type": "string", + "example": "e4ca733e3c1da4bff4cd4b6078f2237a" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ImportExportProfile": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "label", + "sourceEntity", + "fileType", + "delimiter", + "enclosure", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "label": { + "type": "string" + }, + "type": { + "type": "string" + }, + "systemDefault": { + "type": "boolean" + }, + "sourceEntity": { + "type": "string" + }, + "fileType": { + "type": "string" + }, + "delimiter": { + "type": "string" + }, + "enclosure": { + "type": "string" + }, + "mapping": { + "type": "object" + }, + "updateBy": { + "type": "object" + }, + "config": { + "type": "object" + }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "importExportLogs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + }, + "type": "object" + }, + "IntegrationJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "label", + "accessKey", + "secretAccessKey", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "label": { + "type": "string" + }, + "accessKey": { + "type": "string" + }, + "secretAccessKey": { + "type": "string" + }, + "lastUsageAt": { + "type": "string", + "format": "date-time" + }, + "admin": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "createdNotifications": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "notification" + }, + "id": { + "type": "string", + "example": "04f88ea12127fe03b65beffbc2c96954" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + }, + "aclRoles": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/aclRoles" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "acl_role" + }, + "id": { + "type": "string", + "example": "e050a8081a3eb1d193c23cf0ef761183" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Integration": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "label", + "accessKey", + "secretAccessKey", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "label": { + "type": "string" + }, + "accessKey": { + "type": "string" + }, + "secretAccessKey": { + "type": "string" + }, + "lastUsageAt": { + "type": "string", + "format": "date-time" + }, + "admin": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "createdNotifications": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "notification" + }, + "id": { + "type": "string", + "example": "04f88ea12127fe03b65beffbc2c96954" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "aclRoles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } + } + }, + "type": "object" + }, + "IntegrationRole": { + "description": "Added since version: 6.3.3.0", + "required": [ + "integrationId", + "aclRoleId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "integrationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "integration": { + "$ref": "#/components/schemas/Integration" + }, + "role": { + "$ref": "#/components/schemas/AclRole" + } + }, + "type": "object" + }, + "LandingPageJsonApi": { + "description": "Added since version: 6.4.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "createdAt", + "name", + "url" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "active": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "metaTitle": { + "type": "string" + }, + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "url": { + "type": "string" + }, + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "tags": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "cmsPage": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/cmsPage" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7b1460918b1abb93311108f3dc021c9b" + } + } + } + }, + "type": "object" + }, + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + } + }, + "type": "object" + }, + "seoUrls": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/seoUrls" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "seo_url" + }, + "id": { + "type": "string", + "example": "5321b5a71127b8b98cdd4b068ad56c4c" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "LandingPage": { + "description": "Added since version: 6.4.0.0", + "required": [ + "id", + "createdAt", + "name", + "url" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "active": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "metaTitle": { + "type": "string" + }, + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "url": { + "type": "string" + }, + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "seoUrls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + }, + "type": "object" + }, + "LandingPageSalesChannel": { + "description": "Added since version: 6.4.0.0", + "required": [ + "landingPageId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "landingPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "landingPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "landingPage": { + "$ref": "#/components/schemas/LandingPage" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "LandingPageTag": { + "description": "Added since version: 6.4.0.0", + "required": [ + "landingPageId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "landingPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "landingPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "landingPage": { + "$ref": "#/components/schemas/LandingPage" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "LanguageJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "localeId", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "translationCodeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "parent": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "locale": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/locale" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "locale" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fb216d9e8791e63c8d12bdc420956839" + } + } + } + }, + "type": "object" + }, + "translationCode": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/translationCode" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "locale" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "6ef2035242b8fcb7b61c3a41850e60b3" + } + } + } + }, + "type": "object" + }, + "children": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/children" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } + } + } + } + }, + "type": "object" + }, + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + } + }, + "type": "object" + }, + "salesChannelDefaultAssignments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDefaultAssignments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "b23663b2abc0909be9a8027a3fbff74b" + } + } + } + } + }, + "type": "object" + }, + "salesChannelDomains": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDomains" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_domain" + }, + "id": { + "type": "string", + "example": "b60ab8d110194bfe34ef9928ba48ab6d" + } + } + } + } + }, + "type": "object" + }, + "customers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/customers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "4b6f7d34a58ba399f077685951d06738" + } + } + } + } + }, + "type": "object" + }, + "newsletterRecipients": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/newsletterRecipients" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "newsletter_recipient" + }, + "id": { + "type": "string", + "example": "2217f01dc5cddfd5b60387c39867f58e" + } + } + } + } + }, + "type": "object" + }, + "orders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/orders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "example": "12c500ed0b7879105fb46af0f246be87" + } + } + } + } + }, + "type": "object" + }, + "productSearchKeywords": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchKeywords" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_keyword" + }, + "id": { + "type": "string", + "example": "ea9cb6522f347c9212c9459d63c645f4" + } + } + } + } + }, + "type": "object" + }, + "productKeywordDictionaries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productKeywordDictionaries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_keyword_dictionary" + }, + "id": { + "type": "string", + "example": "660e189a383ca4eb148e25eb0df85988" + } + } + } + } + }, + "type": "object" + }, + "productReviews": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productReviews" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review" + }, + "id": { + "type": "string", + "example": "01e78541ea343ed72424a5222796a4cd" + } + } + } + } + }, + "type": "object" + }, + "productSearchConfig": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchConfig" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8d4fbbaa71409309d308e57678de7d7a" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Language": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "localeId", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "translationCodeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "parent": { + "$ref": "#/components/schemas/Language" + }, + "locale": { + "$ref": "#/components/schemas/Locale" + }, + "translationCode": { + "$ref": "#/components/schemas/Locale" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "salesChannelDefaultAssignments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "salesChannelDomains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + }, + "customers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + }, + "newsletterRecipients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + }, + "orders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + }, + "productSearchKeywords": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + }, + "productKeywordDictionaries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + }, + "productReviews": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + }, + "productSearchConfig": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + }, + "type": "object" + }, + "LocaleJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "code", + "createdAt", + "name", + "territory" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "code": { + "type": "string" + }, + "name": { + "type": "string" + }, + "territory": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "languages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/locale/911f0f24bdce6808f4614d6a263b143b/languages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "example": "f3e334d42863e8250c7d03efefbfd387" + } + } + } + } + }, + "type": "object" + }, + "users": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/locale/911f0f24bdce6808f4614d6a263b143b/users" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "example": "9bc65c2abec141778ffaa729489f3e87" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Locale": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "code", + "createdAt", + "name", + "territory" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "code": { + "type": "string" + }, + "name": { + "type": "string" + }, + "territory": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "languages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + }, + "type": "object" + }, + "LogEntryJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "message": { + "type": "string" + }, + "level": { + "type": "integer", + "format": "int64" + }, + "channel": { + "type": "string" + }, + "context": { + "type": "object" + }, + "extra": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "LogEntry": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "message": { + "type": "string" + }, + "level": { + "type": "integer", + "format": "int64" + }, + "channel": { + "type": "string" + }, + "context": { + "type": "object" + }, + "extra": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "MailHeaderFooterJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "systemDefault": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "headerHtml": { + "type": "string" + }, + "headerPlain": { + "type": "string" + }, + "footerHtml": { + "type": "string" + }, + "footerPlain": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/mail-header-footer/d4e12da612e348a322edb9e721a365ef/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MailHeaderFooter": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "systemDefault": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "headerHtml": { + "type": "string" + }, + "headerPlain": { + "type": "string" + }, + "footerHtml": { + "type": "string" + }, + "footerPlain": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + }, + "type": "object" + }, + "MailTemplateJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "mailTemplateTypeId", + "createdAt", + "subject", + "contentHtml", + "contentPlain" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mailTemplateTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "systemDefault": { + "type": "boolean" + }, + "senderName": { + "type": "string" + }, + "description": { + "type": "string" + }, + "subject": { + "type": "string" + }, + "contentHtml": { + "type": "string" + }, + "contentPlain": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "mailTemplateType": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/mailTemplateType" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "mail_template_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f4e3707ad46065609def210a855620cd" + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/media" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "mail_template_media" + }, + "id": { + "type": "string", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MailTemplate": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "mailTemplateTypeId", + "createdAt", + "subject", + "contentHtml", + "contentPlain" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mailTemplateTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "systemDefault": { + "type": "boolean" + }, + "senderName": { + "type": "string" + }, + "description": { + "type": "string" + }, + "subject": { + "type": "string" + }, + "contentHtml": { + "type": "string" + }, + "contentPlain": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "mailTemplateType": { + "$ref": "#/components/schemas/MailTemplateType" + }, + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateMedia" + } + } + }, + "type": "object" + }, + "MailTemplateMedia": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "mailTemplateId", + "languageId", + "mediaId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mailTemplateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "mailTemplate": { + "$ref": "#/components/schemas/MailTemplate" + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "MailTemplateTypeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "technicalName", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "technicalName": { + "type": "string" + }, + "availableEntities": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "templateData": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "mailTemplates": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/mail-template-type/e0107df21530abfba881ccec2728ac79/mailTemplates" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "mail_template" + }, + "id": { + "type": "string", + "example": "e6f502f7d88de75db45325d22998cf6d" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MailTemplateType": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "technicalName", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "technicalName": { + "type": "string" + }, + "availableEntities": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "templateData": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "mailTemplates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } + } + }, + "type": "object" + }, + "MainCategoryJsonApi": { + "description": "Added since version: 6.1.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "categoryId", + "salesChannelId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryVersionId": { + "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": { + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" + } + } + } + }, + "type": "object" + }, + "category": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/category" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c4ef352f74e502ef5e7bc98e6f4e493d" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/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" + } + ] + }, + "MainCategory": { + "description": "Added since version: 6.1.0.0", + "required": [ + "id", + "productId", + "categoryId", + "salesChannelId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryVersionId": { + "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 + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "category": { + "$ref": "#/components/schemas/Category" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "MediaJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mimeType": { + "type": "string", + "readOnly": true + }, + "fileExtension": { + "type": "string", + "readOnly": true + }, + "uploadedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "fileName": { + "type": "string", + "readOnly": true + }, + "fileSize": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "metaData": { + "type": "object", + "readOnly": true + }, + "mediaType": { + "type": "object", + "readOnly": true + }, + "config": { + "type": "object" + }, + "alt": { + "type": "string" + }, + "title": { + "type": "string" + }, + "url": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "path": { + "type": "string" + }, + "hasFile": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "private": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "themes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/themes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "fe021943dcda87150f590b3475afaded" + } + } + } + } + }, + "type": "object" + }, + "themeMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "260be9ecb281c4ff04e7189bb18a35bd" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "tags": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "thumbnails": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/thumbnails" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_thumbnail" + }, + "id": { + "type": "string", + "example": "3b8779ba05b8f0aed49650f3ff8beb4b" + } + } + } + } + }, + "type": "object" + }, + "user": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/user" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ee11cbb19052e40b07aac0ca060c23ee" + } + } + } + }, + "type": "object" + }, + "categories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/categories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" + } + } + } + } + }, + "type": "object" + }, + "productManufacturers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/productManufacturers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_manufacturer" + }, + "id": { + "type": "string", + "example": "30e3a0f8868364c06aa4be63426c1c79" + } + } + } + } + }, + "type": "object" + }, + "productMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/productMedia" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_media" + }, + "id": { + "type": "string", + "example": "2b5e079404830806ea36b6c17438cffd" + } + } + } + } + }, + "type": "object" + }, + "productDownloads": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/productDownloads" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_download" + }, + "id": { + "type": "string", + "example": "86db490c1f4f52d155dbdb978b1f45d3" + } + } + } + } + }, + "type": "object" + }, + "orderLineItemDownloads": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItemDownloads" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item_download" + }, + "id": { + "type": "string", + "example": "8c0a5ecd281c97a912c27c0237b3848f" + } + } + } + } + }, + "type": "object" + }, + "avatarUsers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/avatarUsers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "example": "1fc09529f6c95370eb20b81318ff601f" + } + } + } + } + }, + "type": "object" + }, + "mediaFolder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaFolder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_folder" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70605921a592ee735964394f7948773b" + } + } + } + }, + "type": "object" + }, + "propertyGroupOptions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/propertyGroupOptions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "property_group_option" + }, + "id": { + "type": "string", + "example": "789104e3568fde835b6239b251d4aa07" + } + } + } + } + }, + "type": "object" + }, + "mailTemplateMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/mailTemplateMedia" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "mail_template_media" + }, + "id": { + "type": "string", + "example": "9970132c8439a2e630b655812b031459" + } + } + } + } + }, + "type": "object" + }, + "documentBaseConfigs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/documentBaseConfigs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config" + }, + "id": { + "type": "string", + "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" + } + } + } + } + }, + "type": "object" + }, + "shippingMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/shippingMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "example": "8268b0a6c902fbde485094c2f627b854" + } + } + } + } + }, + "type": "object" + }, + "paymentMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/paymentMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "example": "b631b1ab565525e892f9cdc1242cca14" + } + } + } + } + }, + "type": "object" + }, + "productConfiguratorSettings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/productConfiguratorSettings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_configurator_setting" + }, + "id": { + "type": "string", + "example": "4d46eb45eaf392b26bd46f0ea8cb93e0" + } + } + } + } + }, + "type": "object" + }, + "orderLineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" + } + } + } + } + }, + "type": "object" + }, + "cmsBlocks": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsBlocks" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_block" + }, + "id": { + "type": "string", + "example": "3636c4901eab836dfb837e1a9a37d3c0" + } + } + } + } + }, + "type": "object" + }, + "cmsSections": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsSections" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_section" + }, + "id": { + "type": "string", + "example": "53be3cc1c4a8f41af67a90cf9fd09194" + } + } + } + } + }, + "type": "object" + }, + "cmsPages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsPages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "example": "e676148cc6ffb82b89b3903ecaed2d16" + } + } + } + } + }, + "type": "object" + }, + "documents": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/documents" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "example": "21f64da1e5792c8295b964d159a14491" + } + } + } + } + }, + "type": "object" + }, + "appPaymentMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/appPaymentMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_payment_method" + }, + "id": { + "type": "string", + "example": "e53c737d351047e64a02b7a2a4caffe3" + } + } + } + } + }, + "type": "object" + }, + "appShippingMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/appShippingMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_shipping_method" + }, + "id": { + "type": "string", + "example": "1ad05ee47064647ee5b2dc8c12b1041c" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Media": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mimeType": { + "type": "string", + "readOnly": true + }, + "fileExtension": { + "type": "string", + "readOnly": true + }, + "uploadedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "fileName": { + "type": "string", + "readOnly": true + }, + "fileSize": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "metaData": { + "type": "object", + "readOnly": true + }, + "mediaType": { + "type": "object", + "readOnly": true + }, + "config": { + "type": "object" + }, + "alt": { + "type": "string" + }, + "title": { + "type": "string" + }, + "url": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "path": { + "type": "string" + }, + "hasFile": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "private": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "themes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/themes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "fe021943dcda87150f590b3475afaded" + } + } + } + } + }, + "type": "object" + }, + "themeMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "260be9ecb281c4ff04e7189bb18a35bd" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "thumbnails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + }, + "user": { + "$ref": "#/components/schemas/User" + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "productManufacturers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + }, + "productMedia": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + }, + "productDownloads": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + }, + "orderLineItemDownloads": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + }, + "avatarUsers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + }, + "mediaFolder": { + "$ref": "#/components/schemas/MediaFolder" + }, + "propertyGroupOptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + }, + "mailTemplateMedia": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateMedia" + } + }, + "documentBaseConfigs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + }, + "shippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + }, + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + }, + "productConfiguratorSettings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + }, + "orderLineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + }, + "cmsBlocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + }, + "cmsSections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + }, + "cmsPages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } + }, + "documents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, + "appPaymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + }, + "appShippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + }, + "type": "object" + }, + "MediaDefaultFolderJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "entity", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "folder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-default-folder/8a4b9e9331eadf522da72638577cd527/folder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_folder" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "851148b4fd8fd7ae74bd9100c5c0c898" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MediaDefaultFolder": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "entity", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "folder": { + "$ref": "#/components/schemas/MediaFolder" + } + }, + "type": "object" + }, + "MediaFolderJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "configurationId", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "useParentConfiguration": { + "type": "boolean" + }, + "configurationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "type": "string", + "readOnly": true + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "parent": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_folder" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "children": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/children" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_folder" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/media" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + } + }, + "type": "object" + }, + "defaultFolder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/defaultFolder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_default_folder" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "251dcc9b1621d34e6b01ee14c26b3027" + } + } + } + }, + "type": "object" + }, + "configuration": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/configuration" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_folder_configuration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ccd1066343c95877b75b79d47c36bebe" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MediaFolder": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "configurationId", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "useParentConfiguration": { + "type": "boolean" + }, + "configurationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "type": "string", + "readOnly": true + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "parent": { + "$ref": "#/components/schemas/MediaFolder" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + }, + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + }, + "defaultFolder": { + "$ref": "#/components/schemas/MediaDefaultFolder" + }, + "configuration": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + }, + "type": "object" + }, + "MediaFolderConfigurationJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createThumbnails": { + "type": "boolean" + }, + "keepAspectRatio": { + "type": "boolean" + }, + "thumbnailQuality": { + "type": "integer", + "format": "int64" + }, + "private": { + "type": "boolean" + }, + "noAssociation": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "mediaFolders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaFolders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_folder" + }, + "id": { + "type": "string", + "example": "6e8238687513bde2e85821c839c597c6" + } + } + } + } + }, + "type": "object" + }, + "mediaThumbnailSizes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaThumbnailSizes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_thumbnail_size" + }, + "id": { + "type": "string", + "example": "44dee48a0006e8db2fcec2a5e1456449" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MediaFolderConfiguration": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createThumbnails": { + "type": "boolean" + }, + "keepAspectRatio": { + "type": "boolean" + }, + "thumbnailQuality": { + "type": "integer", + "format": "int64" + }, + "private": { + "type": "boolean" + }, + "noAssociation": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "mediaFolders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + }, + "mediaThumbnailSizes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + }, + "type": "object" + }, + "MediaFolderConfigurationMediaThumbnailSize": { + "description": "Added since version: 6.0.0.0", + "required": [ + "mediaFolderConfigurationId", + "mediaThumbnailSizeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaFolderConfigurationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaThumbnailSizeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaFolderConfiguration": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + }, + "mediaThumbnailSize": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + }, + "type": "object" + }, + "MediaTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "mediaId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "MediaThumbnailJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "mediaId", + "width", + "height", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "width": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "height": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "url": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "path": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MediaThumbnail": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "mediaId", + "width", + "height", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "width": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "height": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "url": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "path": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "MediaThumbnailSizeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "width", + "height", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "width": { + "type": "integer", + "format": "int64" + }, + "height": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "mediaFolderConfigurations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaFolderConfigurations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_folder_configuration" + }, + "id": { + "type": "string", + "example": "056df7a700173d83ebb685b1a890f09b" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MediaThumbnailSize": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "width", + "height", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "width": { + "type": "integer", + "format": "int64" + }, + "height": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "mediaFolderConfigurations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + }, + "type": "object" + }, + "NewsletterRecipientJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "email", + "status", + "hash", + "languageId", + "salesChannelId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "email": { + "type": "string" + }, + "title": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "zipCode": { + "type": "string" + }, + "city": { + "type": "string" + }, + "street": { + "type": "string" + }, + "status": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "confirmedAt": { + "type": "string", + "format": "date-time" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "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": { + "tags": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "salutation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salutation" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "salutation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + } + } + } + }, + "type": "object" + }, + "language": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/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" + } + ] + }, + "NewsletterRecipient": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "email", + "status", + "hash", + "languageId", + "salesChannelId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "email": { + "type": "string" + }, + "title": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "zipCode": { + "type": "string" + }, + "city": { + "type": "string" + }, + "street": { + "type": "string" + }, + "status": { + "type": "string" + }, + "hash": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "confirmedAt": { + "type": "string", + "format": "date-time" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "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 + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "NewsletterRecipientTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "newsletterRecipientId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "newsletterRecipientId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "newsletterRecipient": { + "$ref": "#/components/schemas/NewsletterRecipient" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "NotificationJsonApi": { + "description": "Added since version: 6.4.7.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "status", + "message", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "adminOnly": { + "type": "boolean" + }, + "requiredPrivileges": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "createdByIntegrationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdByUserId": { + "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": { + "createdByIntegration": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByIntegration" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "4698501400b26be8a41def09646e1b59" + } + } + } + }, + "type": "object" + }, + "createdByUser": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByUser" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8a66af2fd5b68899934d19e078c9c111" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Notification": { + "description": "Added since version: 6.4.7.0", + "required": [ + "id", + "status", + "message", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "adminOnly": { + "type": "boolean" + }, + "requiredPrivileges": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "createdByIntegrationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdByUserId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "createdByIntegration": { + "$ref": "#/components/schemas/Integration" + }, + "createdByUser": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "NumberRangeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "typeId", + "global", + "pattern", + "start", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "typeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "global": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "pattern": { + "type": "string" + }, + "start": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "type": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/type" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "number_range_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "599dcce2998a6b40b1e38e8c6006cb0a" + } + } + } + }, + "type": "object" + }, + "numberRangeSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/numberRangeSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "number_range_sales_channel" + }, + "id": { + "type": "string", + "example": "62db021f1d56ae4688775365be68a04f" + } + } + } + } + }, + "type": "object" + }, + "state": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/state" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "number_range_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9ed39e2ea931586b6a985a6942ef573e" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "NumberRange": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "typeId", + "global", + "pattern", + "start", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "typeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "global": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "pattern": { + "type": "string" + }, + "start": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "type": { + "$ref": "#/components/schemas/NumberRangeType" + }, + "numberRangeSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + }, + "state": { + "$ref": "#/components/schemas/NumberRangeState" + } + }, + "type": "object" + }, + "NumberRangeSalesChannelJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "numberRangeId", + "salesChannelId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "numberRangeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "numberRangeTypeId": { + "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": { + "numberRange": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRange" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "number_range" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0345281f3553d43436c3f0cb4796f3c9" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "numberRangeType": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRangeType" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "number_range_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "3d771a402fc5aa3349c2c15637058e8c" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "NumberRangeSalesChannel": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "numberRangeId", + "salesChannelId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "numberRangeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "numberRangeTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "numberRange": { + "$ref": "#/components/schemas/NumberRange" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "numberRangeType": { + "$ref": "#/components/schemas/NumberRangeType" + } + }, + "type": "object" + }, + "NumberRangeStateJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "numberRangeId", + "lastValue", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "numberRangeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "lastValue": { + "type": "integer", + "format": "int64" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "numberRange": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/number-range-state/152af4426362939471d98054e285f66d/numberRange" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "number_range" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0345281f3553d43436c3f0cb4796f3c9" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "NumberRangeState": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "numberRangeId", + "lastValue", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "numberRangeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "lastValue": { + "type": "integer", + "format": "int64" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "numberRange": { + "$ref": "#/components/schemas/NumberRange" + } + }, + "type": "object" + }, + "NumberRangeTypeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "global", + "createdAt", + "typeName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" + }, + "typeName": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "numberRanges": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRanges" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "number_range" + }, + "id": { + "type": "string", + "example": "d28d88efea70a67487116019cff39002" + } + } + } + } + }, + "type": "object" + }, + "numberRangeSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRangeSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "number_range_sales_channel" + }, + "id": { + "type": "string", + "example": "62db021f1d56ae4688775365be68a04f" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "NumberRangeType": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "global", + "createdAt", + "typeName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" + }, + "typeName": { + "type": "string" + }, + "global": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "numberRanges": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } + }, + "numberRangeSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + }, + "type": "object" + }, + "OrderJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "billingAddressId", + "currencyId", + "languageId", + "salesChannelId", + "orderDateTime", + "currencyFactor", + "stateId", + "itemRounding", + "totalRounding", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderNumber": { + "type": "string" + }, + "billingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "billingAddressVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderDateTime": { + "type": "string", + "format": "date-time" + }, + "orderDate": { + "type": "string", + "readOnly": true + }, + "price": { + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], + "properties": { + "netPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "positionPrice": { + "type": "number", + "format": "float" + }, + "rawTotal": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string" + } + }, + "type": "object" + }, + "amountTotal": { + "type": "number", + "format": "float", + "readOnly": true + }, + "amountNet": { + "type": "number", + "format": "float", + "readOnly": true + }, + "positionPrice": { + "type": "number", + "format": "float", + "readOnly": true + }, + "taxStatus": { + "type": "string", + "readOnly": true + }, + "shippingCosts": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "shippingTotal": { + "type": "number", + "format": "float", + "readOnly": true + }, + "currencyFactor": { + "type": "number", + "format": "float" + }, + "deepLinkCode": { + "type": "string" + }, + "affiliateCode": { + "type": "string" + }, + "campaignCode": { + "type": "string" + }, + "customerComment": { + "type": "string" + }, + "source": { + "type": "string" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "customFields": { + "type": "object" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "stateMachineState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/stateMachineState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1ab22d393154f21e3be76aca3ec3ee31" + } + } + } + }, + "type": "object" + }, + "orderCustomer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderCustomer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e90c9c228c1510f5a25902f7a1e8426a" + } + } + } + }, + "type": "object" + }, + "currency": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/currency" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" + } + } + } + }, + "type": "object" + }, + "language": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "addresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/addresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "example": "963e3a2fe559e393bad631f3dc686f69" + } + } + } + } + }, + "type": "object" + }, + "billingAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/billingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7fee8ff88b768662dd8fc06e1b6997d2" + } + } + } + }, + "type": "object" + }, + "deliveries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/deliveries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_delivery" + }, + "id": { + "type": "string", + "example": "6fc31b6b9cd717cc0dcb81152308f8af" + } + } + } + } + }, + "type": "object" + }, + "lineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/lineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "example": "a042af1aa9f3853fe3cd7dabc065568f" + } + } + } + } + }, + "type": "object" + }, + "transactions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/transactions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction" + }, + "id": { + "type": "string", + "example": "c15b977dd99332ca8623fbdfb86827e8" + } + } + } + } + }, + "type": "object" + }, + "documents": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/documents" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "example": "21f64da1e5792c8295b964d159a14491" + } + } + } + } + }, + "type": "object" + }, + "tags": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/createdBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" + } + } + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/updatedBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Order": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "billingAddressId", + "currencyId", + "languageId", + "salesChannelId", + "orderDateTime", + "currencyFactor", + "stateId", + "itemRounding", + "totalRounding", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderNumber": { + "type": "string" + }, + "billingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "billingAddressVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderDateTime": { + "type": "string", + "format": "date-time" + }, + "orderDate": { + "type": "string", + "readOnly": true + }, + "price": { + "required": [ + "netPrice", + "totalPrice", + "positionPrice", + "rawTotal", + "taxStatus" + ], + "properties": { + "netPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "positionPrice": { + "type": "number", + "format": "float" + }, + "rawTotal": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string" + } + }, + "type": "object" + }, + "amountTotal": { + "type": "number", + "format": "float", + "readOnly": true + }, + "amountNet": { + "type": "number", + "format": "float", + "readOnly": true + }, + "positionPrice": { + "type": "number", + "format": "float", + "readOnly": true + }, + "taxStatus": { + "type": "string", + "readOnly": true + }, + "shippingCosts": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "shippingTotal": { + "type": "number", + "format": "float", + "readOnly": true + }, + "currencyFactor": { + "type": "number", + "format": "float" + }, + "deepLinkCode": { + "type": "string" + }, + "affiliateCode": { + "type": "string" + }, + "campaignCode": { + "type": "string" + }, + "customerComment": { + "type": "string" + }, + "source": { + "type": "string" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "customFields": { + "type": "object" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "orderCustomer": { + "$ref": "#/components/schemas/OrderCustomer" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "addresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + }, + "billingAddress": { + "$ref": "#/components/schemas/OrderAddress" + }, + "deliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + }, + "lineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + }, + "transactions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + }, + "documents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "OrderAddressJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "countryId", + "orderId", + "firstName", + "lastName", + "street", + "city", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "street": { + "type": "string" + }, + "zipcode": { + "type": "string" + }, + "city": { + "type": "string" + }, + "company": { + "type": "string" + }, + "department": { + "type": "string" + }, + "title": { + "type": "string" + }, + "vatId": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "additionalAddressLine1": { + "type": "string" + }, + "additionalAddressLine2": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "country": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/country" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" + } + } + } + }, + "type": "object" + }, + "countryState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/countryState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "cb6a9764567191fb74fe28d8d6a4819d" + } + } + } + }, + "type": "object" + }, + "order": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/order" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "orderDeliveries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/orderDeliveries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_delivery" + }, + "id": { + "type": "string", + "example": "0ba472de56dd7ba2e7bb878434321e26" + } + } + } + } + }, + "type": "object" + }, + "salutation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/salutation" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "salutation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderAddress": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "countryId", + "orderId", + "firstName", + "lastName", + "street", + "city", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "street": { + "type": "string" + }, + "zipcode": { + "type": "string" + }, + "city": { + "type": "string" + }, + "company": { + "type": "string" + }, + "department": { + "type": "string" + }, + "title": { + "type": "string" + }, + "vatId": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "additionalAddressLine1": { + "type": "string" + }, + "additionalAddressLine2": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState" + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "orderDeliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + } + }, + "type": "object" + }, + "OrderCustomerJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderId", + "email", + "firstName", + "lastName", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "email": { + "type": "string" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "company": { + "type": "string" + }, + "title": { + "type": "string" + }, + "vatIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "customerNumber": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "remoteAddress": { + "type": "string" + }, + "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": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/order" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "salutation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/salutation" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "salutation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderCustomer": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "orderId", + "email", + "firstName", + "lastName", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "email": { + "type": "string" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "company": { + "type": "string" + }, + "title": { + "type": "string" + }, + "vatIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "customerNumber": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "remoteAddress": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + } + }, + "type": "object" + }, + "OrderDeliveryJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderId", + "shippingOrderAddressId", + "shippingMethodId", + "stateId", + "trackingCodes", + "shippingDateEarliest", + "shippingDateLatest", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingOrderAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingOrderAddressVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "trackingCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "shippingDateEarliest": { + "type": "string", + "format": "date-time" + }, + "shippingDateLatest": { + "type": "string", + "format": "date-time" + }, + "shippingCosts": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "stateMachineState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/stateMachineState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1ab22d393154f21e3be76aca3ec3ee31" + } + } + } + }, + "type": "object" + }, + "order": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/order" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "shippingOrderAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingOrderAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "39a8592767b8b6a5d6b1dbc47e4058ca" + } + } + } + }, + "type": "object" + }, + "shippingMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + } + } + } + }, + "type": "object" + }, + "positions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/positions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_delivery_position" + }, + "id": { + "type": "string", + "example": "365a4a972db646c76d115b3897f2d4de" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderDelivery": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "orderId", + "shippingOrderAddressId", + "shippingMethodId", + "stateId", + "trackingCodes", + "shippingDateEarliest", + "shippingDateLatest", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingOrderAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingOrderAddressVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "trackingCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "shippingDateEarliest": { + "type": "string", + "format": "date-time" + }, + "shippingDateLatest": { + "type": "string", + "format": "date-time" + }, + "shippingCosts": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "shippingOrderAddress": { + "$ref": "#/components/schemas/OrderAddress" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + }, + "type": "object" + }, + "OrderDeliveryPositionJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderDeliveryId", + "orderLineItemId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderDeliveryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderDeliveryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "orderDelivery": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderDelivery" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_delivery" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "473c50bdac32ac0dc66364d121260dce" + } + } + } + }, + "type": "object" + }, + "orderLineItem": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderLineItem" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "72c0cccf44b384eb8f91e0f7074252f8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderDeliveryPosition": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "orderDeliveryId", + "orderLineItemId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderDeliveryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderDeliveryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "orderDelivery": { + "$ref": "#/components/schemas/OrderDelivery" + }, + "orderLineItem": { + "$ref": "#/components/schemas/OrderLineItem" + } + }, + "type": "object" + }, + "OrderLineItemJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderId", + "identifier", + "quantity", + "label", + "position", + "states", + "price", + "children", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "type": "string" + }, + "referencedId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "label": { + "type": "string" + }, + "payload": { + "type": "object" + }, + "good": { + "type": "boolean" + }, + "removable": { + "type": "boolean" + }, + "stackable": { + "type": "boolean" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "states": { + "type": "array", + "items": { + "type": "string" + } + }, + "price": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "priceDefinition": { + "type": "object" + }, + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "description": { + "type": "string" + }, + "type": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "cover": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/cover" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "41d0e299ca1abeb2094852da042165c7" + } + } + } + }, + "type": "object" + }, + "order": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/order" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" + } + } + } + }, + "type": "object" + }, + "promotion": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/promotion" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + } + } + } + }, + "type": "object" + }, + "orderDeliveryPositions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderDeliveryPositions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_delivery_position" + }, + "id": { + "type": "string", + "example": "76d4619a36f864b08f57415baaa685ec" + } + } + } + } + }, + "type": "object" + }, + "orderTransactionCaptureRefundPositions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderTransactionCaptureRefundPositions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction_capture_refund_position" + }, + "id": { + "type": "string", + "example": "c330b64e5adc1e48e07a78aa79e5b27a" + } + } + } + } + }, + "type": "object" + }, + "downloads": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/downloads" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item_download" + }, + "id": { + "type": "string", + "example": "d07d50a751bc6ddf12bf3af0efee9b45" + } + } + } + } + }, + "type": "object" + }, + "parent": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "children": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/children" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderLineItem": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "orderId", + "identifier", + "quantity", + "label", + "position", + "states", + "price", + "children", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "type": "string" + }, + "referencedId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "label": { + "type": "string" + }, + "payload": { + "type": "object" + }, + "good": { + "type": "boolean" + }, + "removable": { + "type": "boolean" + }, + "stackable": { + "type": "boolean" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "states": { + "type": "array", + "items": { + "type": "string" + } + }, + "price": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "priceDefinition": { + "type": "object" + }, + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "description": { + "type": "string" + }, + "type": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "cover": { + "$ref": "#/components/schemas/Media" + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "promotion": { + "$ref": "#/components/schemas/Promotion" + }, + "orderDeliveryPositions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + }, + "orderTransactionCaptureRefundPositions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + }, + "downloads": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + }, + "parent": { + "$ref": "#/components/schemas/OrderLineItem" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + }, + "type": "object" + }, + "OrderLineItemDownloadJsonApi": { + "description": "Added since version: 6.4.19.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderLineItemId", + "mediaId", + "position", + "accessGranted", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "accessGranted": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "orderLineItem": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/orderLineItem" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "72c0cccf44b384eb8f91e0f7074252f8" + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderLineItemDownload": { + "description": "Added since version: 6.4.19.0", + "required": [ + "id", + "orderLineItemId", + "mediaId", + "position", + "accessGranted", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "accessGranted": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "orderLineItem": { + "$ref": "#/components/schemas/OrderLineItem" + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "OrderTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "orderId", + "tagId" + ], + "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}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "OrderTransactionJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderId", + "paymentMethodId", + "amount", + "stateId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "validationData": { + "type": "object" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "stateMachineState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/stateMachineState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1ab22d393154f21e3be76aca3ec3ee31" + } + } + } + }, + "type": "object" + }, + "order": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/order" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" + } + } + } + }, + "type": "object" + }, + "paymentMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/paymentMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" + } + } + } + }, + "type": "object" + }, + "captures": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/captures" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction_capture" + }, + "id": { + "type": "string", + "example": "8856ffdd044d57cd4124a6be5dcea329" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderTransaction": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "orderId", + "paymentMethodId", + "amount", + "stateId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "validationData": { + "type": "object" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + }, + "captures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + }, + "type": "object" + }, + "OrderTransactionCaptureJsonApi": { + "description": "Added since version: 6.4.12.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderTransactionId", + "stateId", + "amount", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderTransactionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "type": "string" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "stateMachineState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/stateMachineState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1ab22d393154f21e3be76aca3ec3ee31" + } + } + } + }, + "type": "object" + }, + "transaction": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/transaction" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f4d5b76a2418eba4baeabc1ed9142b54" + } + } + } + }, + "type": "object" + }, + "refunds": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/refunds" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction_capture_refund" + }, + "id": { + "type": "string", + "example": "0084ff716402199f733f841f5937d3ae" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderTransactionCapture": { + "description": "Added since version: 6.4.12.0", + "required": [ + "id", + "orderTransactionId", + "stateId", + "amount", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderTransactionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "type": "string" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "transaction": { + "$ref": "#/components/schemas/OrderTransaction" + }, + "refunds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + }, + "type": "object" + }, + "OrderTransactionCaptureRefundJsonApi": { + "description": "Added since version: 6.4.12.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "captureId", + "stateId", + "amount", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "captureId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "captureVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "type": "string" + }, + "reason": { + "type": "string" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "stateMachineState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/stateMachineState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1ab22d393154f21e3be76aca3ec3ee31" + } + } + } + }, + "type": "object" + }, + "transactionCapture": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/transactionCapture" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction_capture" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "56b70ce76ce8e9bfbaf80ea040d456b5" + } + } + } + }, + "type": "object" + }, + "positions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/positions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction_capture_refund_position" + }, + "id": { + "type": "string", + "example": "365a4a972db646c76d115b3897f2d4de" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderTransactionCaptureRefund": { + "description": "Added since version: 6.4.12.0", + "required": [ + "id", + "captureId", + "stateId", + "amount", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "captureId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "captureVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "type": "string" + }, + "reason": { + "type": "string" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "transactionCapture": { + "$ref": "#/components/schemas/OrderTransactionCapture" + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + }, + "type": "object" + }, + "OrderTransactionCaptureRefundPositionJsonApi": { + "description": "Added since version: 6.4.12.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "refundId", + "orderLineItemId", + "amount", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "refundId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "refundVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "type": "string" + }, + "reason": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "orderLineItem": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderLineItem" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "72c0cccf44b384eb8f91e0f7074252f8" + } + } + } + }, + "type": "object" + }, + "orderTransactionCaptureRefund": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderTransactionCaptureRefund" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction_capture_refund" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8e55f83da36c39263717541ec1f18de7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderTransactionCaptureRefundPosition": { + "description": "Added since version: 6.4.12.0", + "required": [ + "id", + "refundId", + "orderLineItemId", + "amount", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "refundId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "refundVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "type": "string" + }, + "reason": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "amount": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], + "properties": { + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { + "type": "object" + }, + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + }, + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "orderLineItem": { + "$ref": "#/components/schemas/OrderLineItem" + }, + "orderTransactionCaptureRefund": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + }, + "type": "object" + }, + "PaymentMethodJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pluginId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "handlerIdentifier": { + "type": "string" + }, + "name": { + "type": "string" + }, + "distinguishableName": { + "type": "string", + "readOnly": true + }, + "description": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "afterOrderEnabled": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "availabilityRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "formattedHandlerIdentifier": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "synchronous": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "readOnly": true + }, + "asynchronous": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "readOnly": true + }, + "prepared": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "readOnly": true + }, + "refundable": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "readOnly": true + }, + "recurring": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "readOnly": true + }, + "shortName": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "technicalName": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + }, + "availabilityRule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/availabilityRule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9fbb7961d1cb158094924c679e1b302c" + } + } + } + }, + "type": "object" + }, + "salesChannelDefaultAssignments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannelDefaultAssignments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "b23663b2abc0909be9a8027a3fbff74b" + } + } + } + } + }, + "type": "object" + }, + "plugin": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/plugin" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "plugin" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a24bcf2198b1b13ad985304483f7f324" + } + } + } + }, + "type": "object" + }, + "customers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/customers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "4b6f7d34a58ba399f077685951d06738" + } + } + } + } + }, + "type": "object" + }, + "orderTransactions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/orderTransactions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction" + }, + "id": { + "type": "string", + "example": "3bdb6a464fb3330bd1935325493c5f2c" + } + } + } + } + }, + "type": "object" + }, + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + } + }, + "type": "object" + }, + "appPaymentMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/appPaymentMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "30f64104cd0d0a7bb8a9e07fe4d12d88" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "PaymentMethod": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pluginId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "handlerIdentifier": { + "type": "string" + }, + "name": { + "type": "string" + }, + "distinguishableName": { + "type": "string", + "readOnly": true + }, + "description": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "afterOrderEnabled": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "availabilityRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "formattedHandlerIdentifier": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "synchronous": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "readOnly": true + }, + "asynchronous": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "readOnly": true + }, + "prepared": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "readOnly": true + }, + "refundable": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "readOnly": true + }, + "recurring": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "readOnly": true + }, + "shortName": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "technicalName": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "availabilityRule": { + "$ref": "#/components/schemas/Rule" + }, + "salesChannelDefaultAssignments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "plugin": { + "$ref": "#/components/schemas/Plugin" + }, + "customers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + }, + "orderTransactions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "appPaymentMethod": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + }, + "type": "object" + }, + "PluginJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "baseClass", + "name", + "autoload", + "version", + "createdAt", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "baseClass": { + "type": "string" + }, + "name": { + "type": "string" + }, + "composerName": { + "type": "string" + }, + "autoload": { + "type": "object" + }, + "active": { + "type": "boolean" + }, + "managedByComposer": { + "type": "boolean" + }, + "path": { + "type": "string" + }, + "author": { + "type": "string" + }, + "copyright": { + "type": "string" + }, + "license": { + "type": "string" + }, + "version": { + "type": "string" + }, + "upgradeVersion": { + "type": "string" + }, + "installedAt": { + "type": "string", + "format": "date-time" + }, + "upgradedAt": { + "type": "string", + "format": "date-time" + }, + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "manufacturerLink": { + "type": "string" + }, + "supportLink": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "paymentMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/plugin/409c1892b68cb394799262ac57f6d4f1/paymentMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "example": "b631b1ab565525e892f9cdc1242cca14" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Plugin": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "baseClass", + "name", + "autoload", + "version", + "createdAt", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "baseClass": { + "type": "string" + }, + "name": { + "type": "string" + }, + "composerName": { + "type": "string" + }, + "autoload": { + "type": "object" + }, + "active": { + "type": "boolean" + }, + "managedByComposer": { + "type": "boolean" + }, + "path": { + "type": "string" + }, + "author": { + "type": "string" + }, + "copyright": { + "type": "string" + }, + "license": { + "type": "string" + }, + "version": { + "type": "string" + }, + "upgradeVersion": { + "type": "string" + }, + "installedAt": { + "type": "string", + "format": "date-time" + }, + "upgradedAt": { + "type": "string", + "format": "date-time" + }, + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "manufacturerLink": { + "type": "string" + }, + "supportLink": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + }, + "type": "object" + }, + "ProductJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "taxId", + "price", + "productNumber", + "stock", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "manufacturerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productManufacturerVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "unitId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productMediaVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "deliveryTimeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "featureSetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "object" + }, + "productNumber": { + "type": "string" + }, + "restockTime": { + "type": "integer", + "format": "int64" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "active": { + "type": "boolean" + }, + "available": { + "type": "boolean", + "readOnly": true + }, + "isCloseout": { + "type": "boolean" + }, + "availableStock": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "stock": { + "type": "integer", + "format": "int64" + }, + "variation": { + "type": "array", + "items": { + "type": "string" + } + }, + "displayGroup": { + "type": "string", + "readOnly": true + }, + "variantListingConfig": { + "type": "object" + }, + "variantRestrictions": { + "type": "object" + }, + "manufacturerNumber": { + "type": "string" + }, + "ean": { + "type": "string" + }, + "purchaseSteps": { + "type": "integer", + "format": "int64" + }, + "maxPurchase": { + "type": "integer", + "format": "int64" + }, + "minPurchase": { + "type": "integer", + "format": "int64" + }, + "purchaseUnit": { + "type": "number", + "format": "float" + }, + "referenceUnit": { + "type": "number", + "format": "float" + }, + "shippingFree": { + "type": "boolean" + }, + "purchasePrices": { + "type": "object" + }, + "markAsTopseller": { + "type": "boolean" + }, + "weight": { + "type": "number", + "format": "float" + }, + "width": { + "type": "number", + "format": "float" + }, + "height": { + "type": "number", + "format": "float" + }, + "length": { + "type": "number", + "format": "float" + }, + "releaseDate": { + "type": "string", + "format": "date-time" + }, + "ratingAverage": { + "type": "number", + "format": "float", + "readOnly": true + }, + "categoryTree": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "propertyIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "optionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "streamIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "categoryIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customFieldSetSelectionActive": { + "type": "boolean" + }, + "sales": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "metaDescription": { + "type": "string" + }, + "name": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "description": { + "type": "string" + }, + "metaTitle": { + "type": "string" + }, + "packUnit": { + "type": "string" + }, + "packUnitPlural": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "customSearchKeywords": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "downloads": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/downloads" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_download" + }, + "id": { + "type": "string", + "example": "d07d50a751bc6ddf12bf3af0efee9b45" + } + } + } + } + }, + "type": "object" + }, + "parent": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "children": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/children" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } + } + } + } + }, + "type": "object" + }, + "deliveryTime": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/deliveryTime" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "delivery_time" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8c888ae25a7bd42057370e31f7e01044" + } + } + } + }, + "type": "object" + }, + "tax": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/tax" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "06565e5611f23fdf8cc43e5077b92b54" + } + } + } + }, + "type": "object" + }, + "manufacturer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/manufacturer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_manufacturer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c2904bca62b22443d6cf5e9d89cab204" + } + } + } + }, + "type": "object" + }, + "unit": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/unit" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "unit" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "3e34bdebd9bd5edda27e8728904a2552" + } + } + } + }, + "type": "object" + }, + "cover": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/cover" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "41d0e299ca1abeb2094852da042165c7" + } + } + } + }, + "type": "object" + }, + "featureSet": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/featureSet" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_feature_set" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9cef0cd6ce1c52f0d29b23b7e40dbb17" + } + } + } + }, + "type": "object" + }, + "cmsPage": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/cmsPage" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7b1460918b1abb93311108f3dc021c9b" + } + } + } + }, + "type": "object" + }, + "canonicalProduct": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/canonicalProduct" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "023995a50b56c0de077323e958b2bbcd" + } + } + } + }, + "type": "object" + }, + "prices": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/prices" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_price" + }, + "id": { + "type": "string", + "example": "afae32efe0f84fece3f96b377b768b33" + } + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/media" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_media" + }, + "id": { + "type": "string", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + } + }, + "type": "object" + }, + "crossSellings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/crossSellings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_cross_selling" + }, + "id": { + "type": "string", + "example": "89936e14544d1b403cecef938101b6b0" + } + } + } + } + }, + "type": "object" + }, + "crossSellingAssignedProducts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/crossSellingAssignedProducts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_cross_selling_assigned_products" + }, + "id": { + "type": "string", + "example": "5ee26b69e515f51ece26912961283b6d" + } + } + } + } + }, + "type": "object" + }, + "configuratorSettings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/configuratorSettings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_configurator_setting" + }, + "id": { + "type": "string", + "example": "c0827fee13725d41f1fd7e292243f5aa" + } + } + } + } + }, + "type": "object" + }, + "visibilities": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/visibilities" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_visibility" + }, + "id": { + "type": "string", + "example": "63226fcdfe3316ec1237ef07a8fe6732" + } + } + } + } + }, + "type": "object" + }, + "searchKeywords": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/searchKeywords" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_keyword" + }, + "id": { + "type": "string", + "example": "effbcffaacb8111b531f15e6f4c796d1" + } + } + } + } + }, + "type": "object" + }, + "productReviews": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/productReviews" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review" + }, + "id": { + "type": "string", + "example": "01e78541ea343ed72424a5222796a4cd" + } + } + } + } + }, + "type": "object" + }, + "mainCategories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/mainCategories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "main_category" + }, + "id": { + "type": "string", + "example": "1fb731fc4139cbb575429e28846f0c39" + } + } + } + } + }, + "type": "object" + }, + "seoUrls": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/seoUrls" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "seo_url" + }, + "id": { + "type": "string", + "example": "5321b5a71127b8b98cdd4b068ad56c4c" + } + } + } + } + }, + "type": "object" + }, + "orderLineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/orderLineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" + } + } + } + } + }, + "type": "object" + }, + "wishlists": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/wishlists" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_wishlist_product" + }, + "id": { + "type": "string", + "example": "4ec38c6b2208529c1fadccc7d55d7947" + } + } + } + } + }, + "type": "object" + }, + "options": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/options" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "property_group_option" + }, + "id": { + "type": "string", + "example": "93da65a9fd0004d9477aeac024e08e15" + } + } + } + } + }, + "type": "object" + }, + "properties": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/properties" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "property_group_option" + }, + "id": { + "type": "string", + "example": "74693d2fc58b46bd06410f278e39aa71" + } + } + } + } + }, + "type": "object" + }, + "categories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/categories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" + } + } + } + } + }, + "type": "object" + }, + "streams": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/streams" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "example": "2f6f4768f1c2d7c8f1f54823723f1a70" + } + } + } + } + }, + "type": "object" + }, + "categoriesRo": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/categoriesRo" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "7f0702d3a90d965b8c9158c451f43fdb" + } + } + } + } + }, + "type": "object" + }, + "tags": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "customFieldSets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/customFieldSets" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set" + }, + "id": { + "type": "string", + "example": "9b29ba872ce510f033b31364c8602760" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Product": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "taxId", + "price", + "productNumber", + "stock", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "manufacturerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productManufacturerVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "unitId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productMediaVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "deliveryTimeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "featureSetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "object" + }, + "productNumber": { + "type": "string" + }, + "restockTime": { + "type": "integer", + "format": "int64" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "active": { + "type": "boolean" + }, + "available": { + "type": "boolean", + "readOnly": true + }, + "isCloseout": { + "type": "boolean" + }, + "availableStock": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "stock": { + "type": "integer", + "format": "int64" + }, + "variation": { + "type": "array", + "items": { + "type": "string" + } + }, + "displayGroup": { + "type": "string", + "readOnly": true + }, + "variantListingConfig": { + "type": "object" + }, + "variantRestrictions": { + "type": "object" + }, + "manufacturerNumber": { + "type": "string" + }, + "ean": { + "type": "string" + }, + "purchaseSteps": { + "type": "integer", + "format": "int64" + }, + "maxPurchase": { + "type": "integer", + "format": "int64" + }, + "minPurchase": { + "type": "integer", + "format": "int64" + }, + "purchaseUnit": { + "type": "number", + "format": "float" + }, + "referenceUnit": { + "type": "number", + "format": "float" + }, + "shippingFree": { + "type": "boolean" + }, + "purchasePrices": { + "type": "object" + }, + "markAsTopseller": { + "type": "boolean" + }, + "weight": { + "type": "number", + "format": "float" + }, + "width": { + "type": "number", + "format": "float" + }, + "height": { + "type": "number", + "format": "float" + }, + "length": { + "type": "number", + "format": "float" + }, + "releaseDate": { + "type": "string", + "format": "date-time" + }, + "ratingAverage": { + "type": "number", + "format": "float", + "readOnly": true + }, + "categoryTree": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "propertyIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "optionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "streamIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "categoryIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customFieldSetSelectionActive": { + "type": "boolean" + }, + "sales": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "metaDescription": { + "type": "string" + }, + "name": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "description": { + "type": "string" + }, + "metaTitle": { + "type": "string" + }, + "packUnit": { + "type": "string" + }, + "packUnitPlural": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "customSearchKeywords": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "downloads": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + }, + "parent": { + "$ref": "#/components/schemas/Product" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "deliveryTime": { + "$ref": "#/components/schemas/DeliveryTime" + }, + "tax": { + "$ref": "#/components/schemas/Tax" + }, + "manufacturer": { + "$ref": "#/components/schemas/ProductManufacturer" + }, + "unit": { + "$ref": "#/components/schemas/Unit" + }, + "cover": { + "$ref": "#/components/schemas/ProductMedia" + }, + "featureSet": { + "$ref": "#/components/schemas/ProductFeatureSet" + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" + }, + "canonicalProduct": { + "$ref": "#/components/schemas/Product" + }, + "prices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + }, + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + }, + "crossSellings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + }, + "crossSellingAssignedProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + }, + "configuratorSettings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + }, + "visibilities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + }, + "searchKeywords": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + }, + "productReviews": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + }, + "mainCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + }, + "seoUrls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + }, + "orderLineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + }, + "wishlists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "streams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + }, + "categoriesRo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "customFieldSets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + }, + "type": "object" + }, + "ProductCategory": { + "description": "Added since version: 6.0.0.0", + "required": [ + "productId", + "categoryId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "category": { + "$ref": "#/components/schemas/Category" + } + }, + "type": "object" + }, + "ProductCategoryTree": { + "description": "Added since version: 6.0.0.0", + "required": [ + "productId", + "categoryId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "category": { + "$ref": "#/components/schemas/Category" + } + }, + "type": "object" + }, + "ProductConfiguratorSettingJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "optionId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "optionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "object" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + }, + "option": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/option" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "property_group_option" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ef3e30e070f70244fd6578d88a6b77ac" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductConfiguratorSetting": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "productId", + "optionId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "optionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "object" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "option": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + }, + "type": "object" + }, + "ProductCrossSellingJsonApi": { + "description": "Added since version: 6.1.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "position", + "type", + "productId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "sortBy": { + "type": "string" + }, + "sortDirection": { + "type": "string" + }, + "type": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "format": "int64" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" + } + } + } + }, + "type": "object" + }, + "productStream": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/productStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "49561f6faa0badfce831a183d2ec7c2f" + } + } + } + }, + "type": "object" + }, + "assignedProducts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/assignedProducts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_cross_selling_assigned_products" + }, + "id": { + "type": "string", + "example": "5da5e10eda1b7026499bcd4747d6bdf8" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductCrossSelling": { + "description": "Added since version: 6.1.0.0", + "required": [ + "id", + "name", + "position", + "type", + "productId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "sortBy": { + "type": "string" + }, + "sortDirection": { + "type": "string" + }, + "type": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "limit": { + "type": "integer", + "format": "int64" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + }, + "assignedProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + }, + "type": "object" + }, + "ProductCrossSellingAssignedProductsJsonApi": { + "description": "Added since version: 6.2.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "crossSellingId", + "productId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "crossSellingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-cross-selling-assigned-products/281cee27ae278acd6f5f2bc77ce12736/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" + } + } + } + }, + "type": "object" + }, + "crossSelling": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-cross-selling-assigned-products/281cee27ae278acd6f5f2bc77ce12736/crossSelling" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_cross_selling" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ef23268669fb6d8a7def2b9f2da0aceb" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductCrossSellingAssignedProducts": { + "description": "Added since version: 6.2.0.0", + "required": [ + "id", + "crossSellingId", + "productId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "crossSellingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "crossSelling": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + }, + "type": "object" + }, + "ProductCustomFieldSet": { + "description": "Added since version: 6.3.0.0", + "required": [ + "productId", + "customFieldSetId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFieldSetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "customFieldSet": { + "$ref": "#/components/schemas/CustomFieldSet" + } + }, + "type": "object" + }, + "ProductDownloadJsonApi": { + "description": "Added since version: 6.4.19.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "mediaId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-download/f1371d26b74fe7557f3d9b5aeb2653df/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-download/f1371d26b74fe7557f3d9b5aeb2653df/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductDownload": { + "description": "Added since version: 6.4.19.0", + "required": [ + "id", + "productId", + "mediaId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "ProductExportJsonApi": { + "description": "Added since version: 6.1.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productStreamId", + "storefrontSalesChannelId", + "salesChannelId", + "salesChannelDomainId", + "currencyId", + "fileName", + "accessKey", + "encoding", + "fileFormat", + "generateByCronjob", + "interval", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "storefrontSalesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelDomainId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fileName": { + "type": "string" + }, + "accessKey": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "fileFormat": { + "type": "string" + }, + "includeVariants": { + "type": "boolean" + }, + "generateByCronjob": { + "type": "boolean" + }, + "generatedAt": { + "type": "string", + "format": "date-time" + }, + "interval": { + "type": "integer", + "format": "int64" + }, + "headerTemplate": { + "type": "string" + }, + "bodyTemplate": { + "type": "string" + }, + "footerTemplate": { + "type": "string" + }, + "pausedSchedule": { + "type": "boolean" + }, + "isRunning": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "productStream": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/productStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "49561f6faa0badfce831a183d2ec7c2f" + } + } + } + }, + "type": "object" + }, + "storefrontSalesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/storefrontSalesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "5979d6e259ba5ec4c2b93cf79df6f2e5" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "salesChannelDomain": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/salesChannelDomain" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_domain" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "29c8b34b04e94e35e95e8346954b7fb4" + } + } + } + }, + "type": "object" + }, + "currency": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/currency" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductExport": { + "description": "Added since version: 6.1.0.0", + "required": [ + "id", + "productStreamId", + "storefrontSalesChannelId", + "salesChannelId", + "salesChannelDomainId", + "currencyId", + "fileName", + "accessKey", + "encoding", + "fileFormat", + "generateByCronjob", + "interval", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "storefrontSalesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelDomainId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fileName": { + "type": "string" + }, + "accessKey": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "fileFormat": { + "type": "string" + }, + "includeVariants": { + "type": "boolean" + }, + "generateByCronjob": { + "type": "boolean" + }, + "generatedAt": { + "type": "string", + "format": "date-time" + }, + "interval": { + "type": "integer", + "format": "int64" + }, + "headerTemplate": { + "type": "string" + }, + "bodyTemplate": { + "type": "string" + }, + "footerTemplate": { + "type": "string" + }, + "pausedSchedule": { + "type": "boolean" + }, + "isRunning": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + }, + "storefrontSalesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "salesChannelDomain": { + "$ref": "#/components/schemas/SalesChannelDomain" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + } + }, + "type": "object" + }, + "ProductFeatureSetJsonApi": { + "description": "Added since version: 6.3.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "features": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-feature-set/69d445ae065ef917cd50febab4b55db2/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductFeatureSet": { + "description": "Added since version: 6.3.0.0", + "required": [ + "id", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "features": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + }, + "type": "object" + }, + "ProductKeywordDictionaryJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "languageId", + "keyword" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "keyword": { + "type": "string" + }, + "reversed": { + "type": "string" + }, + "relationships": { + "properties": { + "language": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-keyword-dictionary/a1bc4695aa3e6f80fb42d62e6439296c/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductKeywordDictionary": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "languageId", + "keyword" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "keyword": { + "type": "string" + }, + "reversed": { + "type": "string" + }, + "language": { + "$ref": "#/components/schemas/Language" + } + }, + "type": "object" + }, + "ProductManufacturerJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "link": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-manufacturer/269f96011fc7a4e7a8c1fa87b45b8d1d/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + }, + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-manufacturer/269f96011fc7a4e7a8c1fa87b45b8d1d/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductManufacturer": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "link": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + }, + "type": "object" + }, + "ProductMediaJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "mediaId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + }, + "coverProducts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/coverProducts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "41f7b522ee6fd2f54469cf9ec8e1c8b0" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductMedia": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "productId", + "mediaId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "coverProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + }, + "type": "object" + }, + "ProductOption": { + "description": "Added since version: 6.0.0.0", + "required": [ + "productId", + "optionId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "optionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "option": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + }, + "type": "object" + }, + "ProductPriceJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "ruleId", + "price", + "quantityStart", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "object" + }, + "quantityStart": { + "type": "integer", + "format": "int64" + }, + "quantityEnd": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-price/2003a59b6b10a56954d203e225f83585/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" + } + } + } + }, + "type": "object" + }, + "rule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-price/2003a59b6b10a56954d203e225f83585/rule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "981c1e7b3795da18687613fbd66d4954" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductPrice": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "productId", + "ruleId", + "price", + "quantityStart", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "object" + }, + "quantityStart": { + "type": "integer", + "format": "int64" + }, + "quantityEnd": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "rule": { + "$ref": "#/components/schemas/Rule" + } + }, + "type": "object" + }, + "ProductProperty": { + "description": "Added since version: 6.0.0.0", + "required": [ + "productId", + "optionId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "optionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "option": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + }, + "type": "object" + }, + "ProductReviewJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "salesChannelId", + "languageId", + "title", + "content", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalUser": { + "type": "string" + }, + "externalEmail": { + "type": "string" + }, + "title": { + "type": "string" + }, + "content": { + "type": "string" + }, + "points": { + "type": "number", + "format": "float" + }, + "status": { + "type": "boolean" + }, + "comment": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-review/0793b857a73beced20090eec19b11a3d/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" + } + } + } + }, + "type": "object" + }, + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-review/0793b857a73beced20090eec19b11a3d/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": "/product-review/0793b857a73beced20090eec19b11a3d/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "language": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-review/0793b857a73beced20090eec19b11a3d/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductReview": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "productId", + "salesChannelId", + "languageId", + "title", + "content", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalUser": { + "type": "string" + }, + "externalEmail": { + "type": "string" + }, + "title": { + "type": "string" + }, + "content": { + "type": "string" + }, + "points": { + "type": "number", + "format": "float" + }, + "status": { + "type": "boolean" + }, + "comment": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "language": { + "$ref": "#/components/schemas/Language" + } + }, + "type": "object" + }, + "ProductSearchConfigJsonApi": { + "description": "Added since version: 6.3.5.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "languageId", + "andLogic", + "minSearchLength", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "andLogic": { + "type": "boolean" + }, + "minSearchLength": { + "type": "integer", + "format": "int64" + }, + "excludedTerms": { + "type": "array", + "items": { + "type": "string" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "language": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-search-config/a150b98c1747cffb40453f0c15e18261/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" + } + } + } + }, + "type": "object" + }, + "configFields": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-search-config/a150b98c1747cffb40453f0c15e18261/configFields" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_config_field" + }, + "id": { + "type": "string", + "example": "5334117da647d3f2fb8a82948d56bcc3" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductSearchConfig": { + "description": "Added since version: 6.3.5.0", + "required": [ + "id", + "languageId", + "andLogic", + "minSearchLength", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "andLogic": { + "type": "boolean" + }, + "minSearchLength": { + "type": "integer", + "format": "int64" + }, + "excludedTerms": { + "type": "array", + "items": { + "type": "string" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "configFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + }, + "type": "object" + }, + "ProductSearchConfigFieldJsonApi": { + "description": "Added since version: 6.3.5.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "searchConfigId", + "field", + "tokenize", + "searchable", + "ranking", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "searchConfigId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFieldId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "field": { + "type": "string" + }, + "tokenize": { + "type": "boolean" + }, + "searchable": { + "type": "boolean" + }, + "ranking": { + "type": "integer", + "format": "int64" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "searchConfig": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-search-config-field/38271ca1804968a1c9d07c12719453b8/searchConfig" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bc8281d44069ce8ffd34144fbad1bddd" + } + } + } + }, + "type": "object" + }, + "customField": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-search-config-field/38271ca1804968a1c9d07c12719453b8/customField" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ed2028a1c479c7e0065da597452d9c11" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductSearchConfigField": { + "description": "Added since version: 6.3.5.0", + "required": [ + "id", + "searchConfigId", + "field", + "tokenize", + "searchable", + "ranking", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "searchConfigId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFieldId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "field": { + "type": "string" + }, + "tokenize": { + "type": "boolean" + }, + "searchable": { + "type": "boolean" + }, + "ranking": { + "type": "integer", + "format": "int64" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "searchConfig": { + "$ref": "#/components/schemas/ProductSearchConfig" + }, + "customField": { + "$ref": "#/components/schemas/CustomField" + } + }, + "type": "object" + }, + "ProductSearchKeywordJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "languageId", + "productId", + "keyword", + "ranking", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "keyword": { + "type": "string" + }, + "ranking": { + "type": "number", + "format": "float" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-search-keyword/b704475cf722682ba73e11d9903e09a4/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" + } + } + } + }, + "type": "object" + }, + "language": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-search-keyword/b704475cf722682ba73e11d9903e09a4/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductSearchKeyword": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "languageId", + "productId", + "keyword", + "ranking", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "keyword": { + "type": "string" + }, + "ranking": { + "type": "number", + "format": "float" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "language": { + "$ref": "#/components/schemas/Language" + } + }, + "type": "object" + }, + "ProductSortingJsonApi": { + "description": "Added since version: 6.3.2.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "key", + "priority", + "active", + "fields", + "createdAt", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "locked": { + "type": "boolean" + }, + "key": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "fields": { + "type": "object" + }, + "label": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductSorting": { + "description": "Added since version: 6.3.2.0", + "required": [ + "id", + "key", + "priority", + "active", + "fields", + "createdAt", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "locked": { + "type": "boolean" + }, + "key": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "fields": { + "type": "object" + }, + "label": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + } + }, + "type": "object" + }, + "ProductStreamJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "apiFilter": { + "type": "object", + "readOnly": true + }, + "invalid": { + "type": "boolean", + "readOnly": true + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "filters": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/filters" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream_filter" + }, + "id": { + "type": "string", + "example": "2c9885d2b0c7e26971f60a90f33cf718" + } + } + } + } + }, + "type": "object" + }, + "productCrossSellings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/productCrossSellings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_cross_selling" + }, + "id": { + "type": "string", + "example": "6fa3de1d94218e2ac5a51cbeaca7f846" + } + } + } + } + }, + "type": "object" + }, + "productExports": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/productExports" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_export" + }, + "id": { + "type": "string", + "example": "2cd8793787cda582174c0fc329fbc377" + } + } + } + } + }, + "type": "object" + }, + "categories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/categories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductStream": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "apiFilter": { + "type": "object", + "readOnly": true + }, + "invalid": { + "type": "boolean", + "readOnly": true + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + }, + "productCrossSellings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + }, + "productExports": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + } + }, + "type": "object" + }, + "ProductStreamFilterJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productStreamId", + "type", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "field": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "value": { + "type": "string" + }, + "parameters": { + "type": "object" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "productStream": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/productStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "49561f6faa0badfce831a183d2ec7c2f" + } + } + } + }, + "type": "object" + }, + "parent": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream_filter" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "queries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/queries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream_filter" + }, + "id": { + "type": "string", + "example": "5da7eb4247add5dbd5776c9c0b38460a" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductStreamFilter": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "productStreamId", + "type", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "field": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "value": { + "type": "string" + }, + "parameters": { + "type": "object" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + }, + "parent": { + "$ref": "#/components/schemas/ProductStreamFilter" + }, + "queries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + }, + "type": "object" + }, + "ProductStreamMapping": { + "description": "Added since version: 6.4.0.0", + "required": [ + "productId", + "productStreamId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + } + }, + "type": "object" + }, + "ProductTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "productId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "ProductVisibilityJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "salesChannelId", + "visibility", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visibility": { + "type": "integer", + "format": "int64" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-visibility/e965d09420555f52df9b20f904697d96/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-visibility/e965d09420555f52df9b20f904697d96/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ProductVisibility": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "productId", + "salesChannelId", + "visibility", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visibility": { + "type": "integer", + "format": "int64" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "product": { + "$ref": "#/components/schemas/Product" + } + }, + "type": "object" + }, + "PromotionJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "active", + "priority", + "exclusive", + "useCodes", + "useIndividualCodes", + "useSetGroups", + "preventCombination", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validUntil": { + "type": "string", + "format": "date-time" + }, + "maxRedemptionsGlobal": { + "type": "integer", + "format": "int64" + }, + "maxRedemptionsPerCustomer": { + "type": "integer", + "format": "int64" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "exclusive": { + "type": "boolean" + }, + "code": { + "type": "string" + }, + "useCodes": { + "type": "boolean" + }, + "useIndividualCodes": { + "type": "boolean" + }, + "individualCodePattern": { + "type": "string" + }, + "useSetGroups": { + "type": "boolean" + }, + "customerRestriction": { + "type": "boolean" + }, + "preventCombination": { + "type": "boolean" + }, + "orderCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "ordersPerCustomerCount": { + "type": "object", + "readOnly": true + }, + "exclusionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "setgroups": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion/626a54d37d402d449d6d7541911e0952/setgroups" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion_setgroup" + }, + "id": { + "type": "string", + "example": "3c963571517f44e87274198cb8bb62a8" + } + } + } + } + }, + "type": "object" + }, + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion/626a54d37d402d449d6d7541911e0952/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion_sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + } + }, + "type": "object" + }, + "discounts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion/626a54d37d402d449d6d7541911e0952/discounts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion_discount" + }, + "id": { + "type": "string", + "example": "9544fa2fae515081e7fc27ef2d268642" + } + } + } + } + }, + "type": "object" + }, + "individualCodes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion/626a54d37d402d449d6d7541911e0952/individualCodes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion_individual_code" + }, + "id": { + "type": "string", + "example": "c777247035736c9eae54f8e5dfdcd2aa" + } + } + } + } + }, + "type": "object" + }, + "personaRules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion/626a54d37d402d449d6d7541911e0952/personaRules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "example": "382af96335a79de564c412e6b493d7f3" + } + } + } + } + }, + "type": "object" + }, + "personaCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion/626a54d37d402d449d6d7541911e0952/personaCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "b969a9b0d5772d70ea83383c1be06c82" + } + } + } + } + }, + "type": "object" + }, + "orderRules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion/626a54d37d402d449d6d7541911e0952/orderRules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "example": "ee517f71bf240d98dcf33db6e6ffa881" + } + } + } + } + }, + "type": "object" + }, + "cartRules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion/626a54d37d402d449d6d7541911e0952/cartRules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "example": "6549606ef529fde0a7628b4c0aa7c6ef" + } + } + } + } + }, + "type": "object" + }, + "orderLineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion/626a54d37d402d449d6d7541911e0952/orderLineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Promotion": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "active", + "priority", + "exclusive", + "useCodes", + "useIndividualCodes", + "useSetGroups", + "preventCombination", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validUntil": { + "type": "string", + "format": "date-time" + }, + "maxRedemptionsGlobal": { + "type": "integer", + "format": "int64" + }, + "maxRedemptionsPerCustomer": { + "type": "integer", + "format": "int64" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "exclusive": { + "type": "boolean" + }, + "code": { + "type": "string" + }, + "useCodes": { + "type": "boolean" + }, + "useIndividualCodes": { + "type": "boolean" + }, + "individualCodePattern": { + "type": "string" + }, + "useSetGroups": { + "type": "boolean" + }, + "customerRestriction": { + "type": "boolean" + }, + "preventCombination": { + "type": "boolean" + }, + "orderCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "ordersPerCustomerCount": { + "type": "object", + "readOnly": true + }, + "exclusionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "setgroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + }, + "discounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + }, + "individualCodes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + }, + "personaRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + }, + "personaCustomers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + }, + "orderRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + }, + "cartRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + }, + "orderLineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + }, + "type": "object" + }, + "PromotionCartRule": { + "description": "Added since version: 6.0.0.0", + "required": [ + "promotionId", + "ruleId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotion": { + "$ref": "#/components/schemas/Promotion" + }, + "rule": { + "$ref": "#/components/schemas/Rule" + } + }, + "type": "object" + }, + "PromotionDiscountJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "promotionId", + "scope", + "type", + "value", + "considerAdvancedRules", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "scope": { + "type": "string" + }, + "type": { + "type": "string" + }, + "value": { + "type": "number", + "format": "float" + }, + "considerAdvancedRules": { + "type": "boolean" + }, + "maxValue": { + "type": "number", + "format": "float" + }, + "sorterKey": { + "type": "string" + }, + "applierKey": { + "type": "string" + }, + "usageKey": { + "type": "string" + }, + "pickerKey": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "promotion": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/promotion" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + } + } + } + }, + "type": "object" + }, + "discountRules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/discountRules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "example": "d5a1e52263eb12172f7657376d7622c8" + } + } + } + } + }, + "type": "object" + }, + "promotionDiscountPrices": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/promotionDiscountPrices" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion_discount_prices" + }, + "id": { + "type": "string", + "example": "325723473ecab76b0f45e1554513f779" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "PromotionDiscount": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "promotionId", + "scope", + "type", + "value", + "considerAdvancedRules", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "scope": { + "type": "string" + }, + "type": { + "type": "string" + }, + "value": { + "type": "number", + "format": "float" + }, + "considerAdvancedRules": { + "type": "boolean" + }, + "maxValue": { + "type": "number", + "format": "float" + }, + "sorterKey": { + "type": "string" + }, + "applierKey": { + "type": "string" + }, + "usageKey": { + "type": "string" + }, + "pickerKey": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "promotion": { + "$ref": "#/components/schemas/Promotion" + }, + "discountRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + }, + "promotionDiscountPrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + }, + "type": "object" + }, + "PromotionDiscountPricesJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "discountId", + "currencyId", + "price", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "discountId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "number", + "format": "float" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "promotionDiscount": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion-discount-prices/bed3b77da61f7bd4ccc1f6d17fa416df/promotionDiscount" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion_discount" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "eaeedb5c09dfc7dbf130657ed44ef33f" + } + } + } + }, + "type": "object" + }, + "currency": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion-discount-prices/bed3b77da61f7bd4ccc1f6d17fa416df/currency" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "PromotionDiscountPrices": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "discountId", + "currencyId", + "price", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "discountId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "number", + "format": "float" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "promotionDiscount": { + "$ref": "#/components/schemas/PromotionDiscount" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + } + }, + "type": "object" + }, + "PromotionDiscountRule": { + "description": "Added since version: 6.0.0.0", + "required": [ + "discountId", + "ruleId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "discountId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "discount": { + "$ref": "#/components/schemas/PromotionDiscount" + }, + "rule": { + "$ref": "#/components/schemas/Rule" + } + }, + "type": "object" + }, + "PromotionIndividualCodeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "promotionId", + "code", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "code": { + "type": "string" + }, + "payload": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "promotion": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion-individual-code/139ddd829ed66162c831471f101e3823/promotion" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "PromotionIndividualCode": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "promotionId", + "code", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "code": { + "type": "string" + }, + "payload": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "promotion": { + "$ref": "#/components/schemas/Promotion" + } + }, + "type": "object" + }, + "PromotionOrderRule": { + "description": "Added since version: 6.0.0.0", + "required": [ + "promotionId", + "ruleId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotion": { + "$ref": "#/components/schemas/Promotion" + }, + "rule": { + "$ref": "#/components/schemas/Rule" + } + }, + "type": "object" + }, + "PromotionPersonaCustomer": { + "description": "Added since version: 6.0.0.0", + "required": [ + "promotionId", + "customerId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotion": { + "$ref": "#/components/schemas/Promotion" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + } + }, + "type": "object" + }, + "PromotionPersonaRule": { + "description": "Added since version: 6.0.0.0", + "required": [ + "promotionId", + "ruleId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotion": { + "$ref": "#/components/schemas/Promotion" + }, + "rule": { + "$ref": "#/components/schemas/Rule" + } + }, + "type": "object" + }, + "PromotionSalesChannelJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "promotionId", + "salesChannelId", + "priority", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "promotion": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion-sales-channel/2081c7fb87ec7bafc7a39bf0e33ebaa8/promotion" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion-sales-channel/2081c7fb87ec7bafc7a39bf0e33ebaa8/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" + } + ] + }, + "PromotionSalesChannel": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "promotionId", + "salesChannelId", + "priority", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "promotion": { + "$ref": "#/components/schemas/Promotion" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "PromotionSetgroupJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "promotionId", + "packagerKey", + "sorterKey", + "value", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "packagerKey": { + "type": "string" + }, + "sorterKey": { + "type": "string" + }, + "value": { + "type": "number", + "format": "float" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "promotion": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion-setgroup/d2e23a646d2a711e7af57757b8ff7d3f/promotion" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + } + } + } + }, + "type": "object" + }, + "setGroupRules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion-setgroup/d2e23a646d2a711e7af57757b8ff7d3f/setGroupRules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "example": "a54c38d5a1d9180d689d11234afbbb32" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "PromotionSetgroup": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "promotionId", + "packagerKey", + "sorterKey", + "value", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "packagerKey": { + "type": "string" + }, + "sorterKey": { + "type": "string" + }, + "value": { + "type": "number", + "format": "float" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "promotion": { + "$ref": "#/components/schemas/Promotion" + }, + "setGroupRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + }, + "type": "object" + }, + "PromotionSetgroupRule": { + "description": "Added since version: 6.0.0.0", + "required": [ + "setgroupId", + "ruleId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "setgroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "setgroup": { + "$ref": "#/components/schemas/PromotionSetgroup" + }, + "rule": { + "$ref": "#/components/schemas/Rule" + } + }, + "type": "object" + }, + "PropertyGroupJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "displayType", + "sortingType", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "displayType": { + "type": "string" + }, + "sortingType": { + "type": "string" + }, + "filterable": { + "type": "boolean" + }, + "visibleOnProductDetailPage": { + "type": "boolean" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "options": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/property-group/28691f41cd50e3065fd221390a457a56/options" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "property_group_option" + }, + "id": { + "type": "string", + "example": "93da65a9fd0004d9477aeac024e08e15" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "PropertyGroup": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "displayType", + "sortingType", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "displayType": { + "type": "string" + }, + "sortingType": { + "type": "string" + }, + "filterable": { + "type": "boolean" + }, + "visibleOnProductDetailPage": { + "type": "boolean" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + }, + "type": "object" + }, + "PropertyGroupOptionJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "groupId", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "groupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "colorHexCode": { + "type": "string" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + }, + "group": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/group" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "property_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "db0f6f37ebeb6ea09489124345af2a45" + } + } + } + }, + "type": "object" + }, + "productConfiguratorSettings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/productConfiguratorSettings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_configurator_setting" + }, + "id": { + "type": "string", + "example": "4d46eb45eaf392b26bd46f0ea8cb93e0" + } + } + } + } + }, + "type": "object" + }, + "productProperties": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/productProperties" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "bacd76b9cbbc26cb9854ec57f4d0fef3" + } + } + } + } + }, + "type": "object" + }, + "productOptions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/productOptions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "2e96cc7eba692416e31a6af3230ebf88" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "PropertyGroupOption": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "groupId", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "groupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "colorHexCode": { + "type": "string" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "group": { + "$ref": "#/components/schemas/PropertyGroup" + }, + "productConfiguratorSettings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + }, + "productProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "productOptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + }, + "type": "object" + }, + "RuleJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "priority", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "description": { + "type": "string" + }, + "invalid": { + "type": "boolean", + "readOnly": true + }, + "areas": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "moduleTypes": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "conditions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/conditions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule_condition" + }, + "id": { + "type": "string", + "example": "b5b399ec1fcfe753f58dbafa197efdc1" + } + } + } + } + }, + "type": "object" + }, + "productPrices": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/productPrices" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_price" + }, + "id": { + "type": "string", + "example": "186169119da6d813def53830287d0b9a" + } + } + } + } + }, + "type": "object" + }, + "shippingMethodPrices": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethodPrices" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method_price" + }, + "id": { + "type": "string", + "example": "3702bcc7b41585828b44acbbdcd83b23" + } + } + } + } + }, + "type": "object" + }, + "shippingMethodPriceCalculations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethodPriceCalculations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method_price" + }, + "id": { + "type": "string", + "example": "b8ea8aac272229a90f9a6cb1fcada8d1" + } + } + } + } + }, + "type": "object" + }, + "shippingMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "example": "8268b0a6c902fbde485094c2f627b854" + } + } + } + } + }, + "type": "object" + }, + "paymentMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/paymentMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "example": "b631b1ab565525e892f9cdc1242cca14" + } + } + } + } + }, + "type": "object" + }, + "personaPromotions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/personaPromotions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "example": "e6c8f116c04f26f18410d2d0dbd677db" + } + } + } + } + }, + "type": "object" + }, + "flowSequences": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/flowSequences" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow_sequence" + }, + "id": { + "type": "string", + "example": "3a0d70b6dd3624074e5e15cd07e7fa90" + } + } + } + } + }, + "type": "object" + }, + "taxProviders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/taxProviders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_provider" + }, + "id": { + "type": "string", + "example": "01a1a9d428b6402dc8255d99c787a00e" + } + } + } + } + }, + "type": "object" + }, + "tags": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "orderPromotions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/orderPromotions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "example": "82dea0f7981e729cd7f6303cc8a1c499" + } + } + } + } + }, + "type": "object" + }, + "cartPromotions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/cartPromotions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "example": "2ce52c5be33293c67fb55f29fa4046a7" + } + } + } + } + }, + "type": "object" + }, + "promotionDiscounts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/promotionDiscounts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion_discount" + }, + "id": { + "type": "string", + "example": "3ddb3f7d5ec4f032dc51f294409b68f9" + } + } + } + } + }, + "type": "object" + }, + "promotionSetGroups": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/promotionSetGroups" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion_setgroup" + }, + "id": { + "type": "string", + "example": "b71b82231d40fdedf42133c0e71384f8" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Rule": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "priority", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "description": { + "type": "string" + }, + "invalid": { + "type": "boolean", + "readOnly": true + }, + "areas": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "moduleTypes": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "conditions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + }, + "productPrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + }, + "shippingMethodPrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + }, + "shippingMethodPriceCalculations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + }, + "shippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + }, + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + }, + "personaPromotions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + }, + "flowSequences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + }, + "taxProviders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "orderPromotions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + }, + "cartPromotions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + }, + "promotionDiscounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + }, + "promotionSetGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + }, + "type": "object" + }, + "RuleConditionJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "type", + "ruleId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "scriptId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "value": { + "type": "object" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "rule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/rule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "981c1e7b3795da18687613fbd66d4954" + } + } + } + }, + "type": "object" + }, + "appScriptCondition": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/appScriptCondition" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_script_condition" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d84ccced9bafd192ec0c6b5a8a49bc07" + } + } + } + }, + "type": "object" + }, + "parent": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule_condition" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "children": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/children" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule_condition" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "RuleCondition": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "type", + "ruleId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "scriptId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "value": { + "type": "object" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "rule": { + "$ref": "#/components/schemas/Rule" + }, + "appScriptCondition": { + "$ref": "#/components/schemas/AppScriptCondition" + }, + "parent": { + "$ref": "#/components/schemas/RuleCondition" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + }, + "type": "object" + }, + "RuleTag": { + "description": "Added since version: 6.5.0.0", + "required": [ + "ruleId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "rule": { + "$ref": "#/components/schemas/Rule" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "SalesChannelJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "typeId", + "languageId", + "customerGroupId", + "currencyId", + "paymentMethodId", + "shippingMethodId", + "countryId", + "navigationCategoryId", + "accessKey", + "createdAt", + "name", + "homeEnabled" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "typeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "analyticsId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "navigationCategoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "navigationCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "navigationCategoryDepth": { + "type": "integer", + "format": "int64" + }, + "footerCategoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "footerCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "serviceCategoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "serviceCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mailHeaderFooterId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hreflangDefaultDomainId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "taxCalculationType": { + "type": "string" + }, + "accessKey": { + "type": "string" + }, + "configuration": { + "type": "object" + }, + "active": { + "type": "boolean" + }, + "hreflangActive": { + "type": "boolean" + }, + "maintenance": { + "type": "boolean" + }, + "maintenanceIpWhitelist": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "customFields": { + "type": "object" + }, + "paymentMethodIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "homeCmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "homeCmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "homeSlotConfig": { + "type": "object" + }, + "homeEnabled": { + "type": "boolean" + }, + "homeName": { + "type": "string" + }, + "homeMetaTitle": { + "type": "string" + }, + "homeMetaDescription": { + "type": "string" + }, + "homeKeywords": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "themes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/themes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "fe021943dcda87150f590b3475afaded" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "currencies": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/currencies" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "example": "7f24d9fc4140045241b3f97bcf36bf03" + } + } + } + } + }, + "type": "object" + }, + "languages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/languages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "example": "f3e334d42863e8250c7d03efefbfd387" + } + } + } + } + }, + "type": "object" + }, + "countries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/countries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "example": "71bee43a7a930f904d6194833b9619c9" + } + } + } + } + }, + "type": "object" + }, + "paymentMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/paymentMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "example": "b631b1ab565525e892f9cdc1242cca14" + } + } + } + } + }, + "type": "object" + }, + "shippingMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/shippingMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "example": "8268b0a6c902fbde485094c2f627b854" + } + } + } + } + }, + "type": "object" + }, + "type": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/type" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "599dcce2998a6b40b1e38e8c6006cb0a" + } + } + } + }, + "type": "object" + }, + "language": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" + } + } + } + }, + "type": "object" + }, + "customerGroup": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customerGroup" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "115091b01a7299f28a5ce7e1b712a222" + } + } + } + }, + "type": "object" + }, + "currency": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/currency" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" + } + } + } + }, + "type": "object" + }, + "paymentMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/paymentMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" + } + } + } + }, + "type": "object" + }, + "shippingMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/shippingMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + } + } + } + }, + "type": "object" + }, + "country": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/country" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" + } + } + } + }, + "type": "object" + }, + "orders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/orders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "example": "12c500ed0b7879105fb46af0f246be87" + } + } + } + } + }, + "type": "object" + }, + "customers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "4b6f7d34a58ba399f077685951d06738" + } + } + } + } + }, + "type": "object" + }, + "homeCmsPage": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/homeCmsPage" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "00bba78f79ca4792a3162942ac65c768" + } + } + } + }, + "type": "object" + }, + "domains": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/domains" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_domain" + }, + "id": { + "type": "string", + "example": "e4e46deb7f9cc58c7abfb32e5570b6f3" + } + } + } + } + }, + "type": "object" + }, + "systemConfigs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/systemConfigs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "system_config" + }, + "id": { + "type": "string", + "example": "dbcfb7a885e393eeb296543d06485547" + } + } + } + } + }, + "type": "object" + }, + "navigationCategory": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/navigationCategory" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2194fe03b676158bb7a3a03f1b98b80e" + } + } + } + }, + "type": "object" + }, + "footerCategory": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/footerCategory" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a609a222a2767cf322ee21d72a0ddb3e" + } + } + } + }, + "type": "object" + }, + "serviceCategory": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/serviceCategory" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bc70a595d052072b5d94cffea6d8d5bb" + } + } + } + }, + "type": "object" + }, + "productVisibilities": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productVisibilities" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_visibility" + }, + "id": { + "type": "string", + "example": "a3534dc8df51f93286fcf577a5f8b153" + } + } + } + } + }, + "type": "object" + }, + "hreflangDefaultDomain": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/hreflangDefaultDomain" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_domain" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7e80830860b9b8e5b8fc8d67262680b5" + } + } + } + }, + "type": "object" + }, + "mailHeaderFooter": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/mailHeaderFooter" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "mail_header_footer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a21fbb0e023f5e68d5be77b969e1eb09" + } + } + } + }, + "type": "object" + }, + "newsletterRecipients": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/newsletterRecipients" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "newsletter_recipient" + }, + "id": { + "type": "string", + "example": "2217f01dc5cddfd5b60387c39867f58e" + } + } + } + } + }, + "type": "object" + }, + "numberRangeSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/numberRangeSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "number_range_sales_channel" + }, + "id": { + "type": "string", + "example": "62db021f1d56ae4688775365be68a04f" + } + } + } + } + }, + "type": "object" + }, + "promotionSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/promotionSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion_sales_channel" + }, + "id": { + "type": "string", + "example": "ede6dfd9f261361e1f3ada8c5385d064" + } + } + } + } + }, + "type": "object" + }, + "documentBaseConfigSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/documentBaseConfigSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config_sales_channel" + }, + "id": { + "type": "string", + "example": "9c990fde5b38ff70fc1a07bf84c12a17" + } + } + } + } + }, + "type": "object" + }, + "productReviews": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productReviews" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review" + }, + "id": { + "type": "string", + "example": "01e78541ea343ed72424a5222796a4cd" + } + } + } + } + }, + "type": "object" + }, + "seoUrls": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/seoUrls" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "seo_url" + }, + "id": { + "type": "string", + "example": "5321b5a71127b8b98cdd4b068ad56c4c" + } + } + } + } + }, + "type": "object" + }, + "seoUrlTemplates": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/seoUrlTemplates" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "seo_url_template" + }, + "id": { + "type": "string", + "example": "02cde325fef3e680f529875e8abd60bb" + } + } + } + } + }, + "type": "object" + }, + "mainCategories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/mainCategories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "main_category" + }, + "id": { + "type": "string", + "example": "1fb731fc4139cbb575429e28846f0c39" + } + } + } + } + }, + "type": "object" + }, + "productExports": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productExports" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_export" + }, + "id": { + "type": "string", + "example": "2cd8793787cda582174c0fc329fbc377" + } + } + } + } + }, + "type": "object" + }, + "analytics": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/analytics" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_analytics" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "68c4283db8074b12df1660b31c0220a9" + } + } + } + }, + "type": "object" + }, + "customerGroupsRegistrations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customerGroupsRegistrations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_group" + }, + "id": { + "type": "string", + "example": "ea52a61e886aa27d777ef201c6fb7fff" + } + } + } + } + }, + "type": "object" + }, + "landingPages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/landingPages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "landing_page" + }, + "id": { + "type": "string", + "example": "d60b77f2b3bd69591e3d5e3100926b4d" + } + } + } + } + }, + "type": "object" + }, + "boundCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/boundCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "770f1f7d01437434bcdf89eee15d4bd2" + } + } + } + } + }, + "type": "object" + }, + "wishlists": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/wishlists" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_wishlist" + }, + "id": { + "type": "string", + "example": "4ec38c6b2208529c1fadccc7d55d7947" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannel": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "typeId", + "languageId", + "customerGroupId", + "currencyId", + "paymentMethodId", + "shippingMethodId", + "countryId", + "navigationCategoryId", + "accessKey", + "createdAt", + "name", + "homeEnabled" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "typeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "analyticsId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "navigationCategoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "navigationCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "navigationCategoryDepth": { + "type": "integer", + "format": "int64" + }, + "footerCategoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "footerCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "serviceCategoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "serviceCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mailHeaderFooterId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hreflangDefaultDomainId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "taxCalculationType": { + "type": "string" + }, + "accessKey": { + "type": "string" + }, + "configuration": { + "type": "object" + }, + "active": { + "type": "boolean" + }, + "hreflangActive": { + "type": "boolean" + }, + "maintenance": { + "type": "boolean" + }, + "maintenanceIpWhitelist": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "customFields": { + "type": "object" + }, + "paymentMethodIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "homeCmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "homeCmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "homeSlotConfig": { + "type": "object" + }, + "homeEnabled": { + "type": "boolean" + }, + "homeName": { + "type": "string" + }, + "homeMetaTitle": { + "type": "string" + }, + "homeMetaDescription": { + "type": "string" + }, + "homeKeywords": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "themes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/themes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "fe021943dcda87150f590b3475afaded" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "currencies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } + }, + "languages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + }, + "countries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } + }, + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + }, + "shippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + }, + "type": { + "$ref": "#/components/schemas/SalesChannelType" + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "customerGroup": { + "$ref": "#/components/schemas/CustomerGroup" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "orders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + }, + "customers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + }, + "homeCmsPage": { + "$ref": "#/components/schemas/CmsPage" + }, + "domains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + }, + "systemConfigs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } + }, + "navigationCategory": { + "$ref": "#/components/schemas/Category" + }, + "footerCategory": { + "$ref": "#/components/schemas/Category" + }, + "serviceCategory": { + "$ref": "#/components/schemas/Category" + }, + "productVisibilities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + }, + "hreflangDefaultDomain": { + "$ref": "#/components/schemas/SalesChannelDomain" + }, + "mailHeaderFooter": { + "$ref": "#/components/schemas/MailHeaderFooter" + }, + "newsletterRecipients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + }, + "numberRangeSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + }, + "promotionSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + }, + "documentBaseConfigSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + }, + "productReviews": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + }, + "seoUrls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + }, + "seoUrlTemplates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + }, + "mainCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + }, + "productExports": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + }, + "analytics": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + }, + "customerGroupsRegistrations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } + }, + "landingPages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + }, + "boundCustomers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + }, + "wishlists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + }, + "type": "object" + }, + "SalesChannelAnalyticsJsonApi": { + "description": "Added since version: 6.2.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "trackingId": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "trackOrders": { + "type": "boolean" + }, + "anonymizeIp": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-analytics/d2c88e9b92761eeb97980a50c7d2cdc0/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" + } + ] + }, + "SalesChannelAnalytics": { + "description": "Added since version: 6.2.0.0", + "required": [ + "id", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "trackingId": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "trackOrders": { + "type": "boolean" + }, + "anonymizeIp": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "SalesChannelCountry": { + "description": "Added since version: 6.0.0.0", + "required": [ + "salesChannelId", + "countryId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "country": { + "$ref": "#/components/schemas/Country" + } + }, + "type": "object" + }, + "SalesChannelCurrency": { + "description": "Added since version: 6.0.0.0", + "required": [ + "salesChannelId", + "currencyId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + } + }, + "type": "object" + }, + "SalesChannelDomainJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "url", + "salesChannelId", + "languageId", + "currencyId", + "snippetSetId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "url": { + "type": "string" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "snippetSetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hreflangUseOnlyLocale": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "language": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" + } + } + } + }, + "type": "object" + }, + "currency": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/currency" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" + } + } + } + }, + "type": "object" + }, + "snippetSet": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/snippetSet" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "snippet_set" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "543af5fd1912efc00742534f621046d3" + } + } + } + }, + "type": "object" + }, + "salesChannelDefaultHreflang": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannelDefaultHreflang" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8d7b798a77667d73c422fb222603234c" + } + } + } + }, + "type": "object" + }, + "productExports": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/productExports" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_export" + }, + "id": { + "type": "string", + "example": "2cd8793787cda582174c0fc329fbc377" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelDomain": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "url", + "salesChannelId", + "languageId", + "currencyId", + "snippetSetId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "url": { + "type": "string" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "snippetSetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hreflangUseOnlyLocale": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "snippetSet": { + "$ref": "#/components/schemas/SnippetSet" + }, + "salesChannelDefaultHreflang": { + "$ref": "#/components/schemas/SalesChannel" + }, + "productExports": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + }, + "type": "object" + }, + "SalesChannelLanguage": { + "description": "Added since version: 6.0.0.0", + "required": [ + "salesChannelId", + "languageId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "language": { + "$ref": "#/components/schemas/Language" + } + }, + "type": "object" + }, + "SalesChannelPaymentMethod": { + "description": "Added since version: 6.0.0.0", + "required": [ + "salesChannelId", + "paymentMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + } + }, + "type": "object" + }, + "SalesChannelShippingMethod": { + "description": "Added since version: 6.0.0.0", + "required": [ + "salesChannelId", + "shippingMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + } + }, + "type": "object" + }, + "SalesChannelTypeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverUrl": { + "type": "string" + }, + "iconName": { + "type": "string" + }, + "screenshotUrls": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string" + }, + "manufacturer": { + "type": "string" + }, + "description": { + "type": "string" + }, + "descriptionLong": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-type/569a394914261338c70075564274cb38/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SalesChannelType": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverUrl": { + "type": "string" + }, + "iconName": { + "type": "string" + }, + "screenshotUrls": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string" + }, + "manufacturer": { + "type": "string" + }, + "description": { + "type": "string" + }, + "descriptionLong": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + }, + "type": "object" + }, + "SalutationJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "salutationKey", + "createdAt", + "displayName", + "letterName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationKey": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "letterName": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "customers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/customers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "4b6f7d34a58ba399f077685951d06738" + } + } + } + } + }, + "type": "object" + }, + "customerAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/customerAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "example": "84ed5cbc10cd9f665a8c9f05e49095af" + } + } + } + } + }, + "type": "object" + }, + "orderCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/orderCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_customer" + }, + "id": { + "type": "string", + "example": "1e7dbe7e3bcb48d233fd80588f54c980" + } + } + } + } + }, + "type": "object" + }, + "orderAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/orderAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "example": "c3182f0dc0cc20b4982616d3e0221747" + } + } + } + } + }, + "type": "object" + }, + "newsletterRecipients": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/newsletterRecipients" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "newsletter_recipient" + }, + "id": { + "type": "string", + "example": "2217f01dc5cddfd5b60387c39867f58e" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Salutation": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "salutationKey", + "createdAt", + "displayName", + "letterName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationKey": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "letterName": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "customers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + }, + "customerAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + }, + "orderCustomers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } + }, + "orderAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + }, + "newsletterRecipients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + }, + "type": "object" + }, + "ScheduledTaskJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "scheduledTaskClass", + "runInterval", + "defaultRunInterval", + "status", + "nextExecutionTime", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "scheduledTaskClass": { + "type": "string" + }, + "runInterval": { + "type": "integer", + "format": "int64" + }, + "defaultRunInterval": { + "type": "integer", + "format": "int64" + }, + "status": { + "type": "string" + }, + "lastExecutionTime": { + "type": "string", + "format": "date-time" + }, + "nextExecutionTime": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "ScheduledTask": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "scheduledTaskClass", + "runInterval", + "defaultRunInterval", + "status", + "nextExecutionTime", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "scheduledTaskClass": { + "type": "string" + }, + "runInterval": { + "type": "integer", + "format": "int64" + }, + "defaultRunInterval": { + "type": "integer", + "format": "int64" + }, + "status": { + "type": "string" + }, + "lastExecutionTime": { + "type": "string", + "format": "date-time" + }, + "nextExecutionTime": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "ScriptJsonApi": { + "description": "Added since version: 6.4.7.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "script", + "hook", + "name", + "active", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "script": { + "type": "string" + }, + "hook": { + "type": "string" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/script/f907e651164789346ae0a1e257c462d8/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Script": { + "description": "Added since version: 6.4.7.0", + "required": [ + "id", + "script", + "hook", + "name", + "active", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "script": { + "type": "string" + }, + "hook": { + "type": "string" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "SeoUrlJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "languageId", + "foreignKey", + "routeName", + "pathInfo", + "seoPathInfo", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "foreignKey": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "routeName": { + "type": "string" + }, + "pathInfo": { + "type": "string" + }, + "seoPathInfo": { + "type": "string" + }, + "isCanonical": { + "type": "boolean" + }, + "isModified": { + "type": "boolean" + }, + "isDeleted": { + "type": "boolean" + }, + "error": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "url": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "language": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/seo-url/da349d0533b621e1f2a0c00b3a04cd46/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/seo-url/da349d0533b621e1f2a0c00b3a04cd46/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" + } + ] + }, + "SeoUrl": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "languageId", + "foreignKey", + "routeName", + "pathInfo", + "seoPathInfo", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "foreignKey": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "routeName": { + "type": "string" + }, + "pathInfo": { + "type": "string" + }, + "seoPathInfo": { + "type": "string" + }, + "isCanonical": { + "type": "boolean" + }, + "isModified": { + "type": "boolean" + }, + "isDeleted": { + "type": "boolean" + }, + "error": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "url": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "SeoUrlTemplateJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "entityName", + "routeName", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityName": { + "type": "string" + }, + "routeName": { + "type": "string" + }, + "template": { + "type": "string" + }, + "isValid": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/seo-url-template/58940688e95c02f54877a72861f930bb/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" + } + ] + }, + "SeoUrlTemplate": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "entityName", + "routeName", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityName": { + "type": "string" + }, + "routeName": { + "type": "string" + }, + "template": { + "type": "string" + }, + "isValid": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "ShippingMethodJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "deliveryTimeId", + "taxType", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "availabilityRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "deliveryTimeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxType": { + "type": "string" + }, + "taxId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": { + "type": "string" + }, + "trackingUrl": { + "type": "string" + }, + "technicalName": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "deliveryTime": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/deliveryTime" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "delivery_time" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8c888ae25a7bd42057370e31f7e01044" + } + } + } + }, + "type": "object" + }, + "availabilityRule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/availabilityRule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9fbb7961d1cb158094924c679e1b302c" + } + } + } + }, + "type": "object" + }, + "prices": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/prices" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method_price" + }, + "id": { + "type": "string", + "example": "afae32efe0f84fece3f96b377b768b33" + } + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + }, + "tags": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "orderDeliveries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/orderDeliveries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_delivery" + }, + "id": { + "type": "string", + "example": "0ba472de56dd7ba2e7bb878434321e26" + } + } + } + } + }, + "type": "object" + }, + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + } + }, + "type": "object" + }, + "salesChannelDefaultAssignments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/salesChannelDefaultAssignments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "b23663b2abc0909be9a8027a3fbff74b" + } + } + } + } + }, + "type": "object" + }, + "tax": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tax" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "06565e5611f23fdf8cc43e5077b92b54" + } + } + } + }, + "type": "object" + }, + "appShippingMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/appShippingMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_shipping_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "09f1214e961760dbae11d49b2bf9fa2c" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ShippingMethod": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "deliveryTimeId", + "taxType", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "availabilityRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "deliveryTimeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxType": { + "type": "string" + }, + "taxId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": { + "type": "string" + }, + "trackingUrl": { + "type": "string" + }, + "technicalName": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "deliveryTime": { + "$ref": "#/components/schemas/DeliveryTime" + }, + "availabilityRule": { + "$ref": "#/components/schemas/Rule" + }, + "prices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "orderDeliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "salesChannelDefaultAssignments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "tax": { + "$ref": "#/components/schemas/Tax" + }, + "appShippingMethod": { + "$ref": "#/components/schemas/AppShippingMethod" + } + }, + "type": "object" + }, + "ShippingMethodPriceJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "shippingMethodId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "calculation": { + "type": "integer", + "format": "int64" + }, + "calculationRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quantityStart": { + "type": "number", + "format": "float" + }, + "quantityEnd": { + "type": "number", + "format": "float" + }, + "currencyPrice": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "shippingMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/shippingMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + } + } + } + }, + "type": "object" + }, + "rule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/rule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "981c1e7b3795da18687613fbd66d4954" + } + } + } + }, + "type": "object" + }, + "calculationRule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/calculationRule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "01b78fd34df634d784131ceefffbac99" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "ShippingMethodPrice": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "shippingMethodId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "calculation": { + "type": "integer", + "format": "int64" + }, + "calculationRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quantityStart": { + "type": "number", + "format": "float" + }, + "quantityEnd": { + "type": "number", + "format": "float" + }, + "currencyPrice": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "rule": { + "$ref": "#/components/schemas/Rule" + }, + "calculationRule": { + "$ref": "#/components/schemas/Rule" + } + }, + "type": "object" + }, + "ShippingMethodTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "shippingMethodId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "SnippetJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "setId", + "translationKey", + "value", + "author", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "setId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "translationKey": { + "type": "string" + }, + "value": { + "type": "string" + }, + "author": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "set": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/snippet/c437bb5adb99c55aa0754151c5a61e3d/set" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "snippet_set" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "cdaeeeba9b4a4c5ebf042c0215a7bb0e" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Snippet": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "setId", + "translationKey", + "value", + "author", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "setId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "translationKey": { + "type": "string" + }, + "value": { + "type": "string" + }, + "author": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "set": { + "$ref": "#/components/schemas/SnippetSet" + } + }, + "type": "object" + }, + "SnippetSetJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "baseFile", + "iso", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "baseFile": { + "type": "string" + }, + "iso": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "snippets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/snippet-set/9f6e11952dab122bb6c007faaa8d4880/snippets" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "snippet" + }, + "id": { + "type": "string", + "example": "67be68a348da3b850fb7daa10b034528" + } + } + } + } + }, + "type": "object" + }, + "salesChannelDomains": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/snippet-set/9f6e11952dab122bb6c007faaa8d4880/salesChannelDomains" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_domain" + }, + "id": { + "type": "string", + "example": "b60ab8d110194bfe34ef9928ba48ab6d" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SnippetSet": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "baseFile", + "iso", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "baseFile": { + "type": "string" + }, + "iso": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "snippets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + }, + "salesChannelDomains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + }, + "type": "object" + }, + "StateMachineJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "technicalName", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "initialStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "states": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine/e33d8b3de97b8246976dde33ff4abd48/states" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "example": "34d955a0df5f7af9c9b4e4dccb3c3564" + } + } + } + } + }, + "type": "object" + }, + "transitions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine/e33d8b3de97b8246976dde33ff4abd48/transitions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_transition" + }, + "id": { + "type": "string", + "example": "34fe3c1def90f54754c23fb8df6dbeb0" + } + } + } + } + }, + "type": "object" + }, + "historyEntries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine/e33d8b3de97b8246976dde33ff4abd48/historyEntries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_history" + }, + "id": { + "type": "string", + "example": "83f6d6b77ef224687b7b34cfe4296bea" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "StateMachine": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "technicalName", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "initialStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "states": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + }, + "transitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + }, + "historyEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + }, + "type": "object" + }, + "StateMachineHistoryJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "referencedId", + "referencedVersionId", + "stateMachineId", + "entityName", + "fromStateId", + "toStateId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "referencedId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "referencedVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateMachineId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityName": { + "type": "string" + }, + "fromStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "toStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "transitionActionName": { + "type": "string" + }, + "userId": { + "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": { + "stateMachine": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-history/2981354377022484094791c3f19ffec8/stateMachine" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "341364a811428a3ed8c355c2c4fe6990" + } + } + } + }, + "type": "object" + }, + "fromStateMachineState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-history/2981354377022484094791c3f19ffec8/fromStateMachineState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b108a2a0d303fafc83ef06f6790722e8" + } + } + } + }, + "type": "object" + }, + "toStateMachineState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-history/2981354377022484094791c3f19ffec8/toStateMachineState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d04a8a7ce57fa3ec0bc44aa1cb095713" + } + } + } + }, + "type": "object" + }, + "user": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-history/2981354377022484094791c3f19ffec8/user" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ee11cbb19052e40b07aac0ca060c23ee" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "StateMachineHistory": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "referencedId", + "referencedVersionId", + "stateMachineId", + "entityName", + "fromStateId", + "toStateId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "referencedId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "referencedVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateMachineId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityName": { + "type": "string" + }, + "fromStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "toStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "transitionActionName": { + "type": "string" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "stateMachine": { + "$ref": "#/components/schemas/StateMachine" + }, + "fromStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "toStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "user": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "StateMachineStateJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "technicalName", + "stateMachineId", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "stateMachineId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "stateMachine": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/stateMachine" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "341364a811428a3ed8c355c2c4fe6990" + } + } + } + }, + "type": "object" + }, + "fromStateMachineTransitions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/fromStateMachineTransitions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_transition" + }, + "id": { + "type": "string", + "example": "80afc3e35f99674237f602b393d3b2ba" + } + } + } + } + }, + "type": "object" + }, + "toStateMachineTransitions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/toStateMachineTransitions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_transition" + }, + "id": { + "type": "string", + "example": "eb2ca150be27264985d0fcf20d53408d" + } + } + } + } + }, + "type": "object" + }, + "orderTransactions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderTransactions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction" + }, + "id": { + "type": "string", + "example": "3bdb6a464fb3330bd1935325493c5f2c" + } + } + } + } + }, + "type": "object" + }, + "orderDeliveries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderDeliveries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_delivery" + }, + "id": { + "type": "string", + "example": "0ba472de56dd7ba2e7bb878434321e26" + } + } + } + } + }, + "type": "object" + }, + "orders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "example": "12c500ed0b7879105fb46af0f246be87" + } + } + } + } + }, + "type": "object" + }, + "orderTransactionCaptures": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderTransactionCaptures" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction_capture" + }, + "id": { + "type": "string", + "example": "a32c8bdb9e1154cf4e138a0c8faa7159" + } + } + } + } + }, + "type": "object" + }, + "orderTransactionCaptureRefunds": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderTransactionCaptureRefunds" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction_capture_refund" + }, + "id": { + "type": "string", + "example": "24fe1cc759f5450a1d5984a61ad20bda" + } + } + } + } + }, + "type": "object" + }, + "toStateMachineHistoryEntries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/toStateMachineHistoryEntries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_history" + }, + "id": { + "type": "string", + "example": "01326b3b7d7c9c9182eb3940bb456c50" + } + } + } + } + }, + "type": "object" + }, + "fromStateMachineHistoryEntries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/fromStateMachineHistoryEntries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_history" + }, + "id": { + "type": "string", + "example": "6e4fe8b42b9cffa16c3e7b7e4a2a836d" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "StateMachineState": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "technicalName", + "stateMachineId", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "stateMachineId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "stateMachine": { + "$ref": "#/components/schemas/StateMachine" + }, + "fromStateMachineTransitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + }, + "toStateMachineTransitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + }, + "orderTransactions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + }, + "orderDeliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + }, + "orders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + }, + "orderTransactionCaptures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + }, + "orderTransactionCaptureRefunds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + }, + "toStateMachineHistoryEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + }, + "fromStateMachineHistoryEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + }, + "type": "object" + }, + "StateMachineTransitionJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "actionName", + "stateMachineId", + "fromStateId", + "toStateId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionName": { + "type": "string" + }, + "stateMachineId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fromStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "toStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "stateMachine": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-transition/72d87bcb11bdd3adcb321d14ee8c6515/stateMachine" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "341364a811428a3ed8c355c2c4fe6990" + } + } + } + }, + "type": "object" + }, + "fromStateMachineState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-transition/72d87bcb11bdd3adcb321d14ee8c6515/fromStateMachineState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b108a2a0d303fafc83ef06f6790722e8" + } + } + } + }, + "type": "object" + }, + "toStateMachineState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-transition/72d87bcb11bdd3adcb321d14ee8c6515/toStateMachineState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d04a8a7ce57fa3ec0bc44aa1cb095713" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "StateMachineTransition": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "actionName", + "stateMachineId", + "fromStateId", + "toStateId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionName": { + "type": "string" + }, + "stateMachineId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fromStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "toStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "stateMachine": { + "$ref": "#/components/schemas/StateMachine" + }, + "fromStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "toStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + } + }, + "type": "object" + }, + "SystemConfigJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "configurationKey", + "configurationValue", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configurationKey": { + "type": "string" + }, + "configurationValue": { + "properties": { + "_value": { + "type": "object" + } + }, + "type": "object" + }, + "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": { + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/system-config/a59948b9e45358eaaaa1b13d9cedc248/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" + } + ] + }, + "SystemConfig": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "configurationKey", + "configurationValue", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configurationKey": { + "type": "string" + }, + "configurationValue": { + "properties": { + "_value": { + "type": "object" + } + }, + "type": "object" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "TagJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/media" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + } + }, + "type": "object" + }, + "categories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/categories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" + } + } + } + } + }, + "type": "object" + }, + "customers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/customers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "4b6f7d34a58ba399f077685951d06738" + } + } + } + } + }, + "type": "object" + }, + "orders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/orders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "example": "12c500ed0b7879105fb46af0f246be87" + } + } + } + } + }, + "type": "object" + }, + "shippingMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/shippingMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "example": "8268b0a6c902fbde485094c2f627b854" + } + } + } + } + }, + "type": "object" + }, + "newsletterRecipients": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/newsletterRecipients" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "newsletter_recipient" + }, + "id": { + "type": "string", + "example": "2217f01dc5cddfd5b60387c39867f58e" + } + } + } + } + }, + "type": "object" + }, + "landingPages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/landingPages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "landing_page" + }, + "id": { + "type": "string", + "example": "d60b77f2b3bd69591e3d5e3100926b4d" + } + } + } + } + }, + "type": "object" + }, + "rules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/rules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "example": "a4f86f7bfc24194b276c22e0ef158197" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Tag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "customers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + }, + "orders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + }, + "shippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + }, + "newsletterRecipients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + }, + "landingPages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + }, + "type": "object" + }, + "TaxJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "taxRate", + "name", + "position", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + }, + "position": { + "description": "Added since version: 6.4.0.0.", + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + }, + "rules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/rules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_rule" + }, + "id": { + "type": "string", + "example": "a4f86f7bfc24194b276c22e0ef158197" + } + } + } + } + }, + "type": "object" + }, + "shippingMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/shippingMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "example": "8268b0a6c902fbde485094c2f627b854" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Tax": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "taxRate", + "name", + "position", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + }, + "position": { + "description": "Added since version: 6.4.0.0.", + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + }, + "shippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + }, + "type": "object" + }, + "TaxProviderJsonApi": { + "description": "Added since version: 6.5.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "identifier", + "priority", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "processUrl": { + "type": "string" + }, + "availabilityRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "availabilityRule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tax-provider/c948e3fe09fafe2aa0da1b75ebbd211b/availabilityRule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9fbb7961d1cb158094924c679e1b302c" + } + } + } + }, + "type": "object" + }, + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tax-provider/c948e3fe09fafe2aa0da1b75ebbd211b/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "TaxProvider": { + "description": "Added since version: 6.5.0.0", + "required": [ + "id", + "identifier", + "priority", + "createdAt", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "processUrl": { + "type": "string" + }, + "availabilityRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "availabilityRule": { + "$ref": "#/components/schemas/Rule" + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "TaxRuleJsonApi": { + "description": "Added since version: 6.1.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "taxRuleTypeId", + "countryId", + "taxRate", + "taxId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxRuleTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxRate": { + "type": "number", + "format": "float" + }, + "data": { + "properties": { + "states": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "zipCode": { + "type": "string" + }, + "fromZipCode": { + "type": "string" + }, + "toZipCode": { + "type": "string" + } + }, + "type": "object" + }, + "taxId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "activeFrom": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "type": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tax-rule/0c7d1b4f3382a39cbbf06af100fd4dc9/type" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_rule_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "599dcce2998a6b40b1e38e8c6006cb0a" + } + } + } + }, + "type": "object" + }, + "country": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tax-rule/0c7d1b4f3382a39cbbf06af100fd4dc9/country" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" + } + } + } + }, + "type": "object" + }, + "tax": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tax-rule/0c7d1b4f3382a39cbbf06af100fd4dc9/tax" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "06565e5611f23fdf8cc43e5077b92b54" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "TaxRule": { + "description": "Added since version: 6.1.0.0", + "required": [ + "id", + "taxRuleTypeId", + "countryId", + "taxRate", + "taxId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxRuleTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxRate": { + "type": "number", + "format": "float" + }, + "data": { + "properties": { + "states": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "zipCode": { + "type": "string" + }, + "fromZipCode": { + "type": "string" + }, + "toZipCode": { + "type": "string" + } + }, + "type": "object" + }, + "taxId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "activeFrom": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "type": { + "$ref": "#/components/schemas/TaxRuleType" + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "tax": { + "$ref": "#/components/schemas/Tax" + } + }, + "type": "object" + }, + "TaxRuleTypeJsonApi": { + "description": "Added since version: 6.1.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "technicalName", + "position", + "createdAt", + "typeName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string", + "readOnly": true + }, + "position": { + "type": "integer", + "format": "int64" + }, + "typeName": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "rules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tax-rule-type/ebbaa02c602593b9fea23bc0256355fc/rules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_rule" + }, + "id": { + "type": "string", + "example": "a4f86f7bfc24194b276c22e0ef158197" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "TaxRuleType": { + "description": "Added since version: 6.1.0.0", + "required": [ + "id", + "technicalName", + "position", + "createdAt", + "typeName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string", + "readOnly": true + }, + "position": { + "type": "integer", + "format": "int64" + }, + "typeName": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + } + }, + "type": "object" + }, + "ThemeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "author", + "active", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "author": { + "type": "string" + }, + "description": { + "type": "string" + }, + "labels": { + "type": "object" + }, + "helpTexts": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "previewMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentThemeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "themeJson": { + "type": "object" + }, + "baseConfig": { + "type": "object" + }, + "configValues": { + "type": "object" + }, + "active": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/salesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/media" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + } + }, + "type": "object" + }, + "previewMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/previewMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a7a817fb0e422cff87e878b8ff7ca914" + } + } + } + }, + "type": "object" + }, + "dependentThemes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/dependentThemes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "f0608e2d62b88d9b9da8d6d715b6439c" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Theme": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "author", + "active", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "author": { + "type": "string" + }, + "description": { + "type": "string" + }, + "labels": { + "type": "object" + }, + "helpTexts": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "previewMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentThemeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "themeJson": { + "type": "object" + }, + "baseConfig": { + "type": "object" + }, + "configValues": { + "type": "object" + }, + "active": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + }, + "previewMedia": { + "$ref": "#/components/schemas/Media" + }, + "dependentThemes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } + }, + "type": "object" + }, + "ThemeChild": { + "description": "Added since version: 6.4.8.0", + "required": [ + "parentId", + "childId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "childId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentTheme": { + "$ref": "#/components/schemas/Theme" + }, + "childTheme": { + "$ref": "#/components/schemas/Theme" + } + }, + "type": "object" + }, + "ThemeMedia": { + "description": "Added since version: 6.0.0.0", + "required": [ + "themeId", + "mediaId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "themeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "theme": { + "$ref": "#/components/schemas/Theme" + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "ThemeSalesChannel": { + "description": "Added since version: 6.0.0.0", + "required": [ + "salesChannelId", + "themeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "themeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "theme": { + "$ref": "#/components/schemas/Theme" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "UnitJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "createdAt", + "shortCode", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shortCode": { + "type": "string" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/unit/19c562a36aeb455d09534f93b4f5236f/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Unit": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "createdAt", + "shortCode", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shortCode": { + "type": "string" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + }, + "type": "object" + }, + "UserJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "localeId", + "username", + "firstName", + "lastName", + "email", + "timeZone", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "username": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "title": { + "type": "string" + }, + "email": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + }, + "lastUpdatedPasswordAt": { + "type": "string", + "format": "date-time" + }, + "timeZone": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "avatarId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "createdNotifications": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdNotifications" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "notification" + }, + "id": { + "type": "string", + "example": "04f88ea12127fe03b65beffbc2c96954" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "locale": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/locale" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "locale" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fb216d9e8791e63c8d12bdc420956839" + } + } + } + }, + "type": "object" + }, + "avatarMedia": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/avatarMedia" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "117ab0b986d2b792c775e3beeacca7c7" + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/media" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + } + }, + "type": "object" + }, + "accessKeys": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/accessKeys" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user_access_key" + }, + "id": { + "type": "string", + "example": "d11944e47e101a4aaa8d7947faa56b16" + } + } + } + } + }, + "type": "object" + }, + "configs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/configs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user_config" + }, + "id": { + "type": "string", + "example": "c23f7ab876ac167e05468ef79f046cb7" + } + } + } + } + }, + "type": "object" + }, + "stateMachineHistoryEntries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/stateMachineHistoryEntries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_history" + }, + "id": { + "type": "string", + "example": "c78c7ea361b7def0876b75bd1bd37879" + } + } + } + } + }, + "type": "object" + }, + "importExportLogEntries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/importExportLogEntries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "import_export_log" + }, + "id": { + "type": "string", + "example": "72ec794255f368c7a704e177fa9a4967" + } + } + } + } + }, + "type": "object" + }, + "aclRoles": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/aclRoles" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "acl_role" + }, + "id": { + "type": "string", + "example": "e050a8081a3eb1d193c23cf0ef761183" + } + } + } + } + }, + "type": "object" + }, + "recoveryUser": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/recoveryUser" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user_recovery" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bf6cdb5c30f0f0d234b96e50f2953109" + } + } + } + }, + "type": "object" + }, + "createdOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "example": "20509127ddf2655eb49e3db3b1d710c0" + } + } + } + } + }, + "type": "object" + }, + "updatedOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "example": "9ce34a8be6d860e8bd92feaf79e9a4a2" + } + } + } + } + }, + "type": "object" + }, + "createdCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "c0caccfe18ce8c277f15d100818139a6" + } + } + } + } + }, + "type": "object" + }, + "updatedCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "dddac98f88e37eb31b56e7e1d455fd75" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "User": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "localeId", + "username", + "firstName", + "lastName", + "email", + "timeZone", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "username": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "title": { + "type": "string" + }, + "email": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + }, + "lastUpdatedPasswordAt": { + "type": "string", + "format": "date-time" + }, + "timeZone": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "avatarId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "createdNotifications": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdNotifications" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "notification" + }, + "id": { + "type": "string", + "example": "04f88ea12127fe03b65beffbc2c96954" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "locale": { + "$ref": "#/components/schemas/Locale" + }, + "avatarMedia": { + "$ref": "#/components/schemas/Media" + }, + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + }, + "accessKeys": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } + }, + "configs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } + }, + "stateMachineHistoryEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + }, + "importExportLogEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + }, + "aclRoles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } + }, + "recoveryUser": { + "$ref": "#/components/schemas/UserRecovery" + }, + "createdOrders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + }, + "updatedOrders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + }, + "createdCustomers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + }, + "updatedCustomers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + } + }, + "type": "object" + }, + "UserAccessKeyJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "userId", + "accessKey", + "secretAccessKey", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "accessKey": { + "type": "string" + }, + "secretAccessKey": { + "type": "string" + }, + "lastUsageAt": { + "type": "string", + "format": "date-time" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "user": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user-access-key/01614dd7e96bd79868128dca72e7eff8/user" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ee11cbb19052e40b07aac0ca060c23ee" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "UserAccessKey": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "userId", + "accessKey", + "secretAccessKey", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "accessKey": { + "type": "string" + }, + "secretAccessKey": { + "type": "string" + }, + "lastUsageAt": { + "type": "string", + "format": "date-time" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "user": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "UserConfigJsonApi": { + "description": "Added since version: 6.3.5.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "userId", + "key", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "key": { + "type": "string" + }, + "value": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "user": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user-config/4b55408b66d30e27bb1593401072cd70/user" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ee11cbb19052e40b07aac0ca060c23ee" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "UserConfig": { + "description": "Added since version: 6.3.5.0", + "required": [ + "id", + "userId", + "key", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "key": { + "type": "string" + }, + "value": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "user": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "UserRecoveryJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "hash", + "userId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "type": "string" + }, + "userId": { + "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": { + "user": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user-recovery/f451cbc27abefae127822d81c5dbb338/user" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ee11cbb19052e40b07aac0ca060c23ee" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "UserRecovery": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "hash", + "userId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "type": "string" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "user": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "WebhookJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "eventName", + "url", + "errorCount", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "eventName": { + "type": "string" + }, + "url": { + "type": "string" + }, + "onlyLiveVersion": { + "type": "boolean" + }, + "errorCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "active": { + "type": "boolean" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/webhook/150c7abfca6c489fee5cb82fbb7a9bc4/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Webhook": { + "description": "Added since version: 6.3.1.0", + "required": [ + "id", + "name", + "eventName", + "url", + "errorCount", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "eventName": { + "type": "string" + }, + "url": { + "type": "string" + }, + "onlyLiveVersion": { + "type": "boolean" + }, + "errorCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "active": { + "type": "boolean" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "WebhookEventLogJsonApi": { + "description": "Added since version: 6.4.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "webhookName", + "eventName", + "deliveryStatus", + "url", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "type": "string" + }, + "webhookName": { + "type": "string" + }, + "eventName": { + "type": "string" + }, + "deliveryStatus": { + "type": "string" + }, + "timestamp": { + "type": "integer", + "format": "int64" + }, + "processingTime": { + "type": "integer", + "format": "int64" + }, + "appVersion": { + "type": "string" + }, + "requestContent": { + "type": "object" + }, + "responseContent": { + "type": "object" + }, + "responseStatusCode": { + "type": "integer", + "format": "int64" + }, + "responseReasonPhrase": { + "type": "string" + }, + "url": { + "type": "string" + }, + "onlyLiveVersion": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "WebhookEventLog": { + "description": "Added since version: 6.4.1.0", + "required": [ + "id", + "webhookName", + "eventName", + "deliveryStatus", + "url", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "type": "string" + }, + "webhookName": { + "type": "string" + }, + "eventName": { + "type": "string" + }, + "deliveryStatus": { + "type": "string" + }, + "timestamp": { + "type": "integer", + "format": "int64" + }, + "processingTime": { + "type": "integer", + "format": "int64" + }, + "appVersion": { + "type": "string" + }, + "requestContent": { + "type": "object" + }, + "responseContent": { + "type": "object" + }, + "responseStatusCode": { + "type": "integer", + "format": "int64" + }, + "responseReasonPhrase": { + "type": "string" + }, + "url": { + "type": "string" + }, + "onlyLiveVersion": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "infoConfigResponse": { + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "The Shopware version." + }, + "versionRevision": { + "type": "string", + "description": "The Shopware version revision." + }, + "adminWorker": { + "type": "object", + "description": "Information about the admin worker.", + "properties": { + "enableAdminWorker": { + "type": "boolean", + "description": "State of the admin worker." + }, + "transports": { + "type": "array", + "description": "Configured transports.", + "items": { + "type": "string" + } + } + } + }, + "bundles": { + "type": "object", + "description": "Asset files of active extensions", + "additionalProperties": { + "type": "object", + "properties": { + "css": { + "type": "array", + "items": { + "type": "string", + "description": "Url to the css file." + } + }, + "js": { + "type": "array", + "items": { + "type": "string", + "description": "Url to the js file." + } + } + } + } + }, + "settings": { + "type": "object", + "properties": { + "enableUrlFeature": { + "type": "boolean", + "description": "State of the `urlFeature` setting." + } + } + } + } + }, + "OAuthScopes": { + "description": "OAuth scopes that should be requested.", + "type": "string", + "enum": [ + "write", + "user-verified", + "admin", + "write user-verified", + "write admin", + "user-verified admin", + "write user-verified admin" + ] + }, + "OAuthGrant": { + "type": "object", + "properties": { + "grant_type": { + "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", + "type": "string" + } + }, + "required": [ + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } + } + }, + "OAuthClientCredentialsGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string" + }, + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret" + ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scopes": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" + }, + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "scopes", + "username", + "password" + ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scopes": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" + } + }, + "required": [ + "client_id", + "scopes", + "refresh_token" + ] + } + ] + }, + "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)", + "properties": { + "page": { + "description": "Search result page", + "type": "integer" + }, + "limit": { + "description": "Number of items per result page", + "type": "integer" + }, + "filter": { + "type": "array", + "description": "List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "field": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "type", + "field", + "value" + ] + } + }, + "sort": { + "type": "array", + "description": "Sorting in the search result.", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + }, + "naturalSorting": { + "type": "boolean" + } + }, + "required": [ + "field" + ] + } + }, + "post-filter": { + "type": "array", + "description": "Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "field": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "type", + "field", + "value" + ] + } + }, + "associations": { + "type": "object", + "description": "Used to fetch associations which are not fetched by default." + }, + "aggregations": { + "type": "array", + "description": "Used to perform aggregations on the search result. For more information, see [Search Queries > Aggregations](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#aggregations)", + "items": { + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" + }, + "type": { + "description": "The type of aggregation", + "type": "string" + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + } + }, + "required": [ + "name", + "type", + "field" + ] + } + }, + "grouping": { + "type": "array", + "description": "Perform groupings over certain fields", + "items": { + "type": "string", + "description": "Name of a field" + } + }, + "fields": { + "type": "array", + "description": "Fields which should be returned in the search result.", + "items": { + "type": "string", + "description": "Name of a field" + } + }, + "total-count-mode": { + "description": "Whether the total for the total number of hits should be determined for the search query. none = disabled total count, exact = calculate exact total amount (slow), next-pages = calculate only for next page (fast)", + "type": "string", + "default": "none", + "enum": [ + "none", + "exact", + "next-pages" + ] + } + } + }, + "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" + } + } + } + } + }, + "responses": { + "404": { + "description": "Not Found", + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/failure" + }, + "example": { + "errors": [ + { + "status": "404", + "title": "Not Found", + "description": "Resource with given parameter was not found." + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/failure" + }, + "example": { + "errors": [ + { + "status": "404", + "title": "Not Found", + "description": "Resource with given parameter was not found." + } + ] + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/failure" + }, + "example": { + "errors": [ + { + "status": "403", + "title": "Forbidden", + "description": "This operation is restricted to logged in users." + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/failure" + }, + "example": { + "errors": [ + { + "status": "403", + "title": "Forbidden", + "description": "This operation is restricted to logged in users." + } + ] + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/failure" + }, + "example": { + "errors": [ + { + "status": "401", + "title": "Unauthorized", + "description": "Authorization information is missing or invalid." + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/failure" + }, + "example": { + "errors": [ + { + "status": "401", + "title": "Unauthorized", + "description": "Authorization information is missing or invalid." + } + ] + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/failure" + }, + "example": { + "errors": [ + { + "status": "400", + "title": "Bad Request", + "description": "Bad parameters for this endpoint. See documentation for the correct ones." + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/failure" + }, + "example": { + "errors": [ + { + "status": "400", + "title": "Bad Request", + "description": "Bad parameters for this endpoint. See documentation for the correct ones." + } + ] + } + } + } + }, + "204": { + "description": "No Content" + }, + "OpenApi3": { + "description": "Returns information about the admin API.", + "content": { + "application/json": { + "schema": { + "properties": { + "openapi": { + "type": "string" + }, + "info": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "description": { + "type": "string" + }, + "termsOfService": { + "type": "string", + "format": "uri" + }, + "contact": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "email": { + "type": "string", + "format": "email" + } + } + }, + "license": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "name" + ] + }, + "version": { + "type": "string" + } + }, + "required": [ + "title", + "version" + ] + }, + "jsonSchemaDialect": { + "type": "string" + }, + "webhooks": { + "type": "object" + }, + "servers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + } + }, + "required": [ + "url" + ] + } + }, + "components": { + "type": "object", + "properties": { + "schemas": { + "type": "object" + }, + "responses": { + "type": "object" + }, + "parameters": { + "type": "object" + }, + "examples": { + "type": "object" + }, + "requestBodies": { + "type": "object" + }, + "headers": { + "type": "object" + }, + "securitySchemes": { + "type": "object" + }, + "links": { + "type": "object" + }, + "callbacks": { + "type": "object" + }, + "pathItems": { + "type": "object" + } + } + }, + "security": { + "type": "array", + "items": { + "type": "object" + } + }, + "paths": { + "type": "object" + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "externalDocs": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url" + ] + } + }, + "required": [ + "name" + ] + } + }, + "externalDocs": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url" + ] + } + }, + "type": "object", + "required": [ + "openapi", + "info" + ] + } + } + } + } + }, + "securitySchemes": { + "oAuth": { + "type": "oauth2", + "description": "Authentication API", + "flows": { + "password": { + "tokenUrl": "http://localhost:8000/api/oauth/token", + "scopes": { + "write": "Full write access" + } + }, + "clientCredentials": { + "tokenUrl": "http://localhost:8000/api/oauth/token", + "scopes": { + "write": "Full write access" + } + } + } + } + } + }, + "security": [ + { + "oAuth": [ + "write" + ] + } + ], + "tags": [ + { + "name": "Experimental", + "description": "Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "externalDocs": { + "description": "Find out more", + "url": "https://github.com/shopware/platform/blob/trunk/adr/2023-05-10-experimental-features.md" + } + }, + { + "name": "App", + "description": "The endpoint for operations on App" + }, + { + "name": "App Action Button", + "description": "The endpoint for operations on App Action Button" + }, + { + "name": "App Administration Snippet", + "description": "The endpoint for operations on App Administration Snippet" + }, + { + "name": "App Cms Block", + "description": "The endpoint for operations on App Cms Block" + }, + { + "name": "App Flow Action", + "description": "The endpoint for operations on App Flow Action" + }, + { + "name": "App Flow Event", + "description": "The endpoint for operations on App Flow Event" + }, + { + "name": "App Payment Method", + "description": "The endpoint for operations on App Payment Method" + }, + { + "name": "App Script Condition", + "description": "The endpoint for operations on App Script Condition" + }, + { + "name": "App Shipping Method", + "description": "The endpoint for operations on App Shipping Method" + }, + { + "name": "App Template", + "description": "The endpoint for operations on App Template" + }, + { + "name": "Category", + "description": "The endpoint for operations on Category" + }, + { + "name": "Cms Block", + "description": "The endpoint for operations on Cms Block" + }, + { + "name": "Cms Page", + "description": "The endpoint for operations on Cms Page" + }, + { + "name": "Cms Section", + "description": "The endpoint for operations on Cms Section" + }, + { + "name": "Cms Slot", + "description": "The endpoint for operations on Cms Slot" + }, + { + "name": "Country", + "description": "The endpoint for operations on Country" + }, + { + "name": "Country State", + "description": "The endpoint for operations on Country State" + }, + { + "name": "Currency", + "description": "The endpoint for operations on Currency" + }, + { + "name": "Currency Country Rounding", + "description": "The endpoint for operations on Currency Country Rounding" + }, + { + "name": "Custom Entity", + "description": "The endpoint for operations on Custom Entity" + }, + { + "name": "Custom Field", + "description": "The endpoint for operations on Custom Field" + }, + { + "name": "Custom Field Set", + "description": "The endpoint for operations on Custom Field Set" + }, + { + "name": "Custom Field Set Relation", + "description": "The endpoint for operations on Custom Field Set Relation" + }, + { + "name": "Customer", + "description": "The endpoint for operations on Customer" + }, + { + "name": "Customer Address", + "description": "The endpoint for operations on Customer Address" + }, + { + "name": "Customer Group", + "description": "The endpoint for operations on Customer Group" + }, + { + "name": "Customer Recovery", + "description": "The endpoint for operations on Customer Recovery" + }, + { + "name": "Customer Wishlist", + "description": "The endpoint for operations on Customer Wishlist" + }, + { + "name": "Customer Wishlist Product", + "description": "The endpoint for operations on Customer Wishlist Product" + }, + { + "name": "Delivery Time", + "description": "The endpoint for operations on Delivery Time" + }, + { + "name": "Document", + "description": "The endpoint for operations on Document" + }, + { + "name": "Document Base Config", + "description": "The endpoint for operations on Document Base Config" + }, + { + "name": "Document Base Config Sales Channel", + "description": "The endpoint for operations on Document Base Config Sales Channel" + }, + { + "name": "Document Type", + "description": "The endpoint for operations on Document Type" + }, + { + "name": "Flow", + "description": "The endpoint for operations on Flow" + }, + { + "name": "Flow Sequence", + "description": "The endpoint for operations on Flow Sequence" + }, + { + "name": "Flow Template", + "description": "The endpoint for operations on Flow Template" + }, + { + "name": "Import Export File", + "description": "The endpoint for operations on Import Export File" + }, + { + "name": "Import Export Log", + "description": "The endpoint for operations on Import Export Log" + }, + { + "name": "Import Export Profile", + "description": "The endpoint for operations on Import Export Profile" + }, + { + "name": "Integration", + "description": "The endpoint for operations on Integration" + }, + { + "name": "Landing Page", + "description": "The endpoint for operations on Landing Page" + }, + { + "name": "Language", + "description": "The endpoint for operations on Language" + }, + { + "name": "Locale", + "description": "The endpoint for operations on Locale" + }, + { + "name": "Log Entry", + "description": "The endpoint for operations on Log Entry" + }, + { + "name": "Mail Header Footer", + "description": "The endpoint for operations on Mail Header Footer" + }, + { + "name": "Mail Template", + "description": "The endpoint for operations on Mail Template" + }, + { + "name": "Mail Template Type", + "description": "The endpoint for operations on Mail Template Type" + }, + { + "name": "Main Category", + "description": "The endpoint for operations on Main Category" + }, + { + "name": "Media", + "description": "The endpoint for operations on Media" + }, + { + "name": "Media Default Folder", + "description": "The endpoint for operations on Media Default Folder" + }, + { + "name": "Media Folder", + "description": "The endpoint for operations on Media Folder" + }, + { + "name": "Media Folder Configuration", + "description": "The endpoint for operations on Media Folder Configuration" + }, + { + "name": "Media Thumbnail", + "description": "The endpoint for operations on Media Thumbnail" + }, + { + "name": "Media Thumbnail Size", + "description": "The endpoint for operations on Media Thumbnail Size" + }, + { + "name": "Newsletter Recipient", + "description": "The endpoint for operations on Newsletter Recipient" + }, + { + "name": "Notification", + "description": "The endpoint for operations on Notification" + }, + { + "name": "Number Range", + "description": "The endpoint for operations on Number Range" + }, + { + "name": "Number Range Sales Channel", + "description": "The endpoint for operations on Number Range Sales Channel" + }, + { + "name": "Number Range State", + "description": "The endpoint for operations on Number Range State" + }, + { + "name": "Number Range Type", + "description": "The endpoint for operations on Number Range Type" + }, + { + "name": "Order", + "description": "The endpoint for operations on Order" + }, + { + "name": "Order Address", + "description": "The endpoint for operations on Order Address" + }, + { + "name": "Order Customer", + "description": "The endpoint for operations on Order Customer" + }, + { + "name": "Order Delivery", + "description": "The endpoint for operations on Order Delivery" + }, + { + "name": "Order Delivery Position", + "description": "The endpoint for operations on Order Delivery Position" + }, + { + "name": "Order Line Item", + "description": "The endpoint for operations on Order Line Item" + }, + { + "name": "Order Line Item Download", + "description": "The endpoint for operations on Order Line Item Download" + }, + { + "name": "Order Transaction", + "description": "The endpoint for operations on Order Transaction" + }, + { + "name": "Order Transaction Capture", + "description": "The endpoint for operations on Order Transaction Capture" + }, + { + "name": "Order Transaction Capture Refund", + "description": "The endpoint for operations on Order Transaction Capture Refund" + }, + { + "name": "Order Transaction Capture Refund Position", + "description": "The endpoint for operations on Order Transaction Capture Refund Position" + }, + { + "name": "Payment Method", + "description": "The endpoint for operations on Payment Method" + }, + { + "name": "Plugin", + "description": "The endpoint for operations on Plugin" + }, + { + "name": "Product", + "description": "The endpoint for operations on Product" + }, + { + "name": "Product Configurator Setting", + "description": "The endpoint for operations on Product Configurator Setting" + }, + { + "name": "Product Cross Selling", + "description": "The endpoint for operations on Product Cross Selling" + }, + { + "name": "Product Cross Selling Assigned Products", + "description": "The endpoint for operations on Product Cross Selling Assigned Products" + }, + { + "name": "Product Download", + "description": "The endpoint for operations on Product Download" + }, + { + "name": "Product Export", + "description": "The endpoint for operations on Product Export" + }, + { + "name": "Product Feature Set", + "description": "The endpoint for operations on Product Feature Set" + }, + { + "name": "Product Keyword Dictionary", + "description": "The endpoint for operations on Product Keyword Dictionary" + }, + { + "name": "Product Manufacturer", + "description": "The endpoint for operations on Product Manufacturer" + }, + { + "name": "Product Media", + "description": "The endpoint for operations on Product Media" + }, + { + "name": "Product Price", + "description": "The endpoint for operations on Product Price" + }, + { + "name": "Product Review", + "description": "The endpoint for operations on Product Review" + }, + { + "name": "Product Search Config", + "description": "The endpoint for operations on Product Search Config" + }, + { + "name": "Product Search Config Field", + "description": "The endpoint for operations on Product Search Config Field" + }, + { + "name": "Product Search Keyword", + "description": "The endpoint for operations on Product Search Keyword" + }, + { + "name": "Product Sorting", + "description": "The endpoint for operations on Product Sorting" + }, + { + "name": "Product Stream", + "description": "The endpoint for operations on Product Stream" + }, + { + "name": "Product Stream Filter", + "description": "The endpoint for operations on Product Stream Filter" + }, + { + "name": "Product Visibility", + "description": "The endpoint for operations on Product Visibility" + }, + { + "name": "Promotion", + "description": "The endpoint for operations on Promotion" + }, + { + "name": "Promotion Discount", + "description": "The endpoint for operations on Promotion Discount" + }, + { + "name": "Promotion Discount Prices", + "description": "The endpoint for operations on Promotion Discount Prices" + }, + { + "name": "Promotion Individual Code", + "description": "The endpoint for operations on Promotion Individual Code" + }, + { + "name": "Promotion Sales Channel", + "description": "The endpoint for operations on Promotion Sales Channel" + }, + { + "name": "Promotion Setgroup", + "description": "The endpoint for operations on Promotion Setgroup" + }, + { + "name": "Property Group", + "description": "The endpoint for operations on Property Group" + }, + { + "name": "Property Group Option", + "description": "The endpoint for operations on Property Group Option" + }, + { + "name": "Rule", + "description": "The endpoint for operations on Rule" + }, + { + "name": "Rule Condition", + "description": "The endpoint for operations on Rule Condition" + }, + { + "name": "Sales Channel", + "description": "The endpoint for operations on Sales Channel" + }, + { + "name": "Sales Channel Analytics", + "description": "The endpoint for operations on Sales Channel Analytics" + }, + { + "name": "Sales Channel Domain", + "description": "The endpoint for operations on Sales Channel Domain" + }, + { + "name": "Sales Channel Type", + "description": "The endpoint for operations on Sales Channel Type" + }, + { + "name": "Salutation", + "description": "The endpoint for operations on Salutation" + }, + { + "name": "Scheduled Task", + "description": "The endpoint for operations on Scheduled Task" + }, + { + "name": "Script", + "description": "The endpoint for operations on Script" + }, + { + "name": "Seo Url", + "description": "The endpoint for operations on Seo Url" + }, + { + "name": "Seo Url Template", + "description": "The endpoint for operations on Seo Url Template" + }, + { + "name": "Shipping Method", + "description": "The endpoint for operations on Shipping Method" + }, + { + "name": "Shipping Method Price", + "description": "The endpoint for operations on Shipping Method Price" + }, + { + "name": "Snippet", + "description": "The endpoint for operations on Snippet" + }, + { + "name": "Snippet Set", + "description": "The endpoint for operations on Snippet Set" + }, + { + "name": "State Machine", + "description": "The endpoint for operations on State Machine" + }, + { + "name": "State Machine History", + "description": "The endpoint for operations on State Machine History" + }, + { + "name": "State Machine State", + "description": "The endpoint for operations on State Machine State" + }, + { + "name": "State Machine Transition", + "description": "The endpoint for operations on State Machine Transition" + }, + { + "name": "System Config", + "description": "The endpoint for operations on System Config" + }, + { + "name": "Tag", + "description": "The endpoint for operations on Tag" + }, + { + "name": "Tax", + "description": "The endpoint for operations on Tax" + }, + { + "name": "Tax Provider", + "description": "The endpoint for operations on Tax Provider" + }, + { + "name": "Tax Rule", + "description": "The endpoint for operations on Tax Rule" + }, + { + "name": "Tax Rule Type", + "description": "The endpoint for operations on Tax Rule Type" + }, + { + "name": "Theme", + "description": "The endpoint for operations on Theme" + }, + { + "name": "Unit", + "description": "The endpoint for operations on Unit" + }, + { + "name": "User", + "description": "The endpoint for operations on User" + }, + { + "name": "User Access Key", + "description": "The endpoint for operations on User Access Key" + }, + { + "name": "User Config", + "description": "The endpoint for operations on User Config" + }, + { + "name": "User Recovery", + "description": "The endpoint for operations on User Recovery" + }, + { + "name": "Webhook", + "description": "The endpoint for operations on Webhook" + }, + { + "name": "Webhook Event Log", + "description": "The endpoint for operations on Webhook Event Log" + } + ] +} diff --git a/adminapi.json b/adminapi.json index 3b6cf90..d627058 100644 --- a/adminapi.json +++ b/adminapi.json @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.7.9999999-dev" + "version": "6.7.9.1" }, "servers": [ { @@ -58984,15 +58984,14 @@ } } }, - "/sales-channel-tracking-customer": { + "/sales-channel-type": { "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Sales Channel Type" ], - "summary": "List with basic information of Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingCustomerList", + "summary": "List with basic information of Sales Channel Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalesChannelTypeList", "parameters": [ { "name": "limit", @@ -59021,7 +59020,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Tracking Customer resources.", + "description": "List of Sales Channel Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -59040,7 +59039,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelType" } } ] @@ -59054,16 +59053,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-tracking-customer?limit=25" + "example": "/sales-channel-type?limit=25" }, "last": { - "example": "/sales-channel-tracking-customer?limit=25&page=11" + "example": "/sales-channel-type?limit=25&page=11" }, "next": { - "example": "/sales-channel-tracking-customer?limit=25&page=4" + "example": "/sales-channel-type?limit=25&page=4" }, "prev": { - "example": "/sales-channel-tracking-customer?limit=25&page=2" + "example": "/sales-channel-type?limit=25&page=2" } } } @@ -59084,7 +59083,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -59099,12 +59098,11 @@ }, "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Sales Channel Type" ], - "summary": "Create a new Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "createSalesChannelTrackingCustomer", + "summary": "Create a new Sales Channel Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSalesChannelType", "parameters": [ { "name": "_response", @@ -59123,14 +59121,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelType" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -59142,7 +59140,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -59157,7 +59155,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -59173,15 +59171,14 @@ } } }, - "/search/sales-channel-tracking-customer": { + "/search/sales-channel-type": { "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Sales Channel Type" ], - "summary": "Search for the Sales Channel Tracking Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "searchSalesChannelTrackingCustomer", + "summary": "Search for the Sales Channel Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSalesChannelType", "parameters": [ { "name": "sw-include-search-info", @@ -59209,7 +59206,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingCustomer", + "description": "List of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -59223,7 +59220,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -59241,7 +59238,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -59258,20 +59255,19 @@ } } }, - "/sales-channel-tracking-customer/{id}": { + "/sales-channel-type/{id}": { "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Sales Channel Type" ], - "summary": "Detailed information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingCustomer", + "summary": "Detailed information about a Sales Channel Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -59281,7 +59277,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -59293,7 +59289,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -59308,7 +59304,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -59325,17 +59321,16 @@ }, "delete": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Sales Channel Type" ], - "summary": "Delete a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "deleteSalesChannelTrackingCustomer", + "summary": "Delete a Sales Channel Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -59366,17 +59361,16 @@ }, "patch": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Sales Channel Type" ], - "summary": "Partially update information about a Sales Channel Tracking Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "updateSalesChannelTrackingCustomer", + "summary": "Partially update information about a Sales Channel Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -59394,18 +59388,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Tracking Customer resource.", + "description": "Partially update information about a Sales Channel Type resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelType" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -59417,7 +59411,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -59432,7 +59426,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -59451,15 +59445,14 @@ } } }, - "/aggregate/sales-channel-tracking-customer": { + "/aggregate/sales-channel-type": { "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Sales Channel Type" ], - "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", + "summary": "Aggregate for the Sales Channel Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannelType", "requestBody": { "required": true, "content": { @@ -59483,7 +59476,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingCustomer", + "description": "List of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -59497,7 +59490,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -59515,7 +59508,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -59532,15 +59525,14 @@ } } }, - "/sales-channel-tracking-order": { + "/salutation": { "get": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Salutation" ], - "summary": "List with basic information of Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingOrderList", + "summary": "List with basic information of Salutation resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalutationList", "parameters": [ { "name": "limit", @@ -59569,7 +59561,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Tracking Order resources.", + "description": "List of Salutation resources.", "content": { "application/vnd.api+json": { "schema": { @@ -59588,7 +59580,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/Salutation" } } ] @@ -59602,16 +59594,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-tracking-order?limit=25" + "example": "/salutation?limit=25" }, "last": { - "example": "/sales-channel-tracking-order?limit=25&page=11" + "example": "/salutation?limit=25&page=11" }, "next": { - "example": "/sales-channel-tracking-order?limit=25&page=4" + "example": "/salutation?limit=25&page=4" }, "prev": { - "example": "/sales-channel-tracking-order?limit=25&page=2" + "example": "/salutation?limit=25&page=2" } } } @@ -59632,7 +59624,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/Salutation" } } } @@ -59647,12 +59639,11 @@ }, "post": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Salutation" ], - "summary": "Create a new Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "createSalesChannelTrackingOrder", + "summary": "Fetches salutations with a criteria obj.", + "description": "Fetches salutations with a criteria obj.", + "operationId": "createSalutation", "parameters": [ { "name": "_response", @@ -59671,14 +59662,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/Salutation" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -59690,7 +59681,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/Salutation" } } } @@ -59705,7 +59696,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/Salutation" } } } @@ -59721,15 +59712,14 @@ } } }, - "/search/sales-channel-tracking-order": { + "/search/salutation": { "post": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Salutation" ], - "summary": "Search for the Sales Channel Tracking Order resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "searchSalesChannelTrackingOrder", + "summary": "Search for the Salutation resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSalutation", "parameters": [ { "name": "sw-include-search-info", @@ -59757,7 +59747,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingOrder", + "description": "List of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -59771,7 +59761,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/Salutation" } } } @@ -59789,7 +59779,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/Salutation" } } } @@ -59806,20 +59796,19 @@ } } }, - "/sales-channel-tracking-order/{id}": { + "/salutation/{id}": { "get": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Salutation" ], - "summary": "Detailed information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "getSalesChannelTrackingOrder", + "summary": "Detailed information about a Salutation resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalutation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -59829,7 +59818,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -59841,7 +59830,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/Salutation" } } } @@ -59856,7 +59845,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/Salutation" } } } @@ -59873,17 +59862,16 @@ }, "delete": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Salutation" ], - "summary": "Delete a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "deleteSalesChannelTrackingOrder", + "summary": "Delete a Salutation resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSalutation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -59914,17 +59902,16 @@ }, "patch": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Salutation" ], - "summary": "Partially update information about a Sales Channel Tracking Order resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.7.9.0", - "operationId": "updateSalesChannelTrackingOrder", + "summary": "Partially update information about a Salutation resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateSalutation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_order", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -59942,18 +59929,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Tracking Order resource.", + "description": "Partially update information about a Salutation resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/Salutation" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -59965,7 +59952,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/Salutation" } } } @@ -59980,7 +59967,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/Salutation" } } } @@ -59999,15 +59986,14 @@ } } }, - "/aggregate/sales-channel-tracking-order": { + "/aggregate/salutation": { "post": { "tags": [ - "Sales Channel Tracking Order", - "Experimental" + "Salutation" ], - "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", + "summary": "Aggregate for the Salutation resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalutation", "requestBody": { "required": true, "content": { @@ -60031,7 +60017,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingOrder", + "description": "List of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -60045,7 +60031,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/Salutation" } } } @@ -60063,7 +60049,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/Salutation" } } } @@ -60080,14 +60066,14 @@ } } }, - "/sales-channel-type": { + "/scheduled-task": { "get": { "tags": [ - "Sales Channel Type" + "Scheduled Task" ], - "summary": "List with basic information of Sales Channel Type resources.", + "summary": "List with basic information of Scheduled Task resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelTypeList", + "operationId": "getScheduledTaskList", "parameters": [ { "name": "limit", @@ -60116,7 +60102,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Type resources.", + "description": "List of Scheduled Task resources.", "content": { "application/vnd.api+json": { "schema": { @@ -60135,7 +60121,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/ScheduledTask" } } ] @@ -60149,16 +60135,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-type?limit=25" + "example": "/scheduled-task?limit=25" }, "last": { - "example": "/sales-channel-type?limit=25&page=11" + "example": "/scheduled-task?limit=25&page=11" }, "next": { - "example": "/sales-channel-type?limit=25&page=4" + "example": "/scheduled-task?limit=25&page=4" }, "prev": { - "example": "/sales-channel-type?limit=25&page=2" + "example": "/scheduled-task?limit=25&page=2" } } } @@ -60179,7 +60165,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -60194,11 +60180,11 @@ }, "post": { "tags": [ - "Sales Channel Type" + "Scheduled Task" ], - "summary": "Create a new Sales Channel Type resources.", + "summary": "Create a new Scheduled Task resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannelType", + "operationId": "createScheduledTask", "parameters": [ { "name": "_response", @@ -60217,14 +60203,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/ScheduledTask" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -60236,7 +60222,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -60251,7 +60237,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -60267,14 +60253,14 @@ } } }, - "/search/sales-channel-type": { + "/search/scheduled-task": { "post": { "tags": [ - "Sales Channel Type" + "Scheduled Task" ], - "summary": "Search for the Sales Channel Type resources.", + "summary": "Search for the Scheduled Task resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSalesChannelType", + "operationId": "searchScheduledTask", "parameters": [ { "name": "sw-include-search-info", @@ -60302,7 +60288,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelType", + "description": "List of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -60316,7 +60302,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -60334,7 +60320,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -60351,19 +60337,19 @@ } } }, - "/sales-channel-type/{id}": { + "/scheduled-task/{id}": { "get": { "tags": [ - "Sales Channel Type" + "Scheduled Task" ], - "summary": "Detailed information about a Sales Channel Type resource.", + "summary": "Detailed information about a Scheduled Task resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelType", + "operationId": "getScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -60373,7 +60359,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -60385,7 +60371,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -60400,7 +60386,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -60417,16 +60403,16 @@ }, "delete": { "tags": [ - "Sales Channel Type" + "Scheduled Task" ], - "summary": "Delete a Sales Channel Type resource.", + "summary": "Delete a Scheduled Task resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSalesChannelType", + "operationId": "deleteScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -60457,16 +60443,16 @@ }, "patch": { "tags": [ - "Sales Channel Type" + "Scheduled Task" ], - "summary": "Partially update information about a Sales Channel Type resource.", + "summary": "Partially update information about a Scheduled Task resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSalesChannelType", + "operationId": "updateScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -60484,18 +60470,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Type resource.", + "description": "Partially update information about a Scheduled Task resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/ScheduledTask" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -60507,7 +60493,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -60522,7 +60508,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -60541,14 +60527,14 @@ } } }, - "/aggregate/sales-channel-type": { + "/aggregate/scheduled-task": { "post": { "tags": [ - "Sales Channel Type" + "Scheduled Task" ], - "summary": "Aggregate for the Sales Channel Type resources.", + "summary": "Aggregate for the Scheduled Task resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannelType", + "operationId": "aggregateScheduledTask", "requestBody": { "required": true, "content": { @@ -60572,7 +60558,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelType", + "description": "List of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -60586,7 +60572,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -60604,7 +60590,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -60621,14 +60607,14 @@ } } }, - "/salutation": { + "/script": { "get": { "tags": [ - "Salutation" + "Script" ], - "summary": "List with basic information of Salutation resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalutationList", + "summary": "List with basic information of Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "getScriptList", "parameters": [ { "name": "limit", @@ -60657,7 +60643,7 @@ ], "responses": { "200": { - "description": "List of Salutation resources.", + "description": "List of Script resources.", "content": { "application/vnd.api+json": { "schema": { @@ -60676,7 +60662,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Script" } } ] @@ -60690,16 +60676,16 @@ "type": "object", "properties": { "first": { - "example": "/salutation?limit=25" + "example": "/script?limit=25" }, "last": { - "example": "/salutation?limit=25&page=11" + "example": "/script?limit=25&page=11" }, "next": { - "example": "/salutation?limit=25&page=4" + "example": "/script?limit=25&page=4" }, "prev": { - "example": "/salutation?limit=25&page=2" + "example": "/script?limit=25&page=2" } } } @@ -60720,7 +60706,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Script" } } } @@ -60735,11 +60721,11 @@ }, "post": { "tags": [ - "Salutation" + "Script" ], - "summary": "Fetches salutations with a criteria obj.", - "description": "Fetches salutations with a criteria obj.", - "operationId": "createSalutation", + "summary": "Create a new Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "createScript", "parameters": [ { "name": "_response", @@ -60758,14 +60744,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Script" } } } }, "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -60777,7 +60763,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Script" } } } @@ -60792,7 +60778,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Script" } } } @@ -60808,14 +60794,14 @@ } } }, - "/search/salutation": { + "/search/script": { "post": { "tags": [ - "Salutation" + "Script" ], - "summary": "Search for the Salutation resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSalutation", + "summary": "Search for the Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "searchScript", "parameters": [ { "name": "sw-include-search-info", @@ -60843,7 +60829,7 @@ }, "responses": { "200": { - "description": "List of Salutation", + "description": "List of Script", "content": { "application/vnd.api+json": { "schema": { @@ -60857,7 +60843,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Script" } } } @@ -60875,7 +60861,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Script" } } } @@ -60892,19 +60878,19 @@ } } }, - "/salutation/{id}": { + "/script/{id}": { "get": { "tags": [ - "Salutation" + "Script" ], - "summary": "Detailed information about a Salutation resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalutation", + "summary": "Detailed information about a Script resource.", + "description": "Available since: 6.4.7.0", + "operationId": "getScript", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -60914,7 +60900,7 @@ ], "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -60926,7 +60912,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Script" } } } @@ -60941,7 +60927,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Script" } } } @@ -60958,16 +60944,16 @@ }, "delete": { "tags": [ - "Salutation" + "Script" ], - "summary": "Delete a Salutation resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSalutation", + "summary": "Delete a Script resource.", + "description": "Available since: 6.4.7.0", + "operationId": "deleteScript", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -60998,16 +60984,16 @@ }, "patch": { "tags": [ - "Salutation" + "Script" ], - "summary": "Partially update information about a Salutation resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSalutation", + "summary": "Partially update information about a Script resource.", + "description": "Available since: 6.4.7.0", + "operationId": "updateScript", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -61025,18 +61011,18 @@ } ], "requestBody": { - "description": "Partially update information about a Salutation resource.", + "description": "Partially update information about a Script resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Script" } } } }, "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -61048,7 +61034,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Script" } } } @@ -61063,7 +61049,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Script" } } } @@ -61082,14 +61068,14 @@ } } }, - "/aggregate/salutation": { + "/aggregate/script": { "post": { "tags": [ - "Salutation" + "Script" ], - "summary": "Aggregate for the Salutation resources.", + "summary": "Aggregate for the Script resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalutation", + "operationId": "aggregateScript", "requestBody": { "required": true, "content": { @@ -61113,7 +61099,7 @@ }, "responses": { "200": { - "description": "List of Salutation", + "description": "List of Script", "content": { "application/vnd.api+json": { "schema": { @@ -61127,7 +61113,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Script" } } } @@ -61145,7 +61131,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Script" } } } @@ -61162,14 +61148,14 @@ } } }, - "/scheduled-task": { + "/seo-url": { "get": { "tags": [ - "Scheduled Task" + "Seo Url" ], - "summary": "List with basic information of Scheduled Task resources.", + "summary": "List with basic information of Seo Url resources.", "description": "Available since: 6.0.0.0", - "operationId": "getScheduledTaskList", + "operationId": "getSeoUrlList", "parameters": [ { "name": "limit", @@ -61198,7 +61184,7 @@ ], "responses": { "200": { - "description": "List of Scheduled Task resources.", + "description": "List of Seo Url resources.", "content": { "application/vnd.api+json": { "schema": { @@ -61217,7 +61203,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SeoUrl" } } ] @@ -61231,16 +61217,16 @@ "type": "object", "properties": { "first": { - "example": "/scheduled-task?limit=25" + "example": "/seo-url?limit=25" }, "last": { - "example": "/scheduled-task?limit=25&page=11" + "example": "/seo-url?limit=25&page=11" }, "next": { - "example": "/scheduled-task?limit=25&page=4" + "example": "/seo-url?limit=25&page=4" }, "prev": { - "example": "/scheduled-task?limit=25&page=2" + "example": "/seo-url?limit=25&page=2" } } } @@ -61261,7 +61247,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -61276,11 +61262,11 @@ }, "post": { "tags": [ - "Scheduled Task" + "Seo Url" ], - "summary": "Create a new Scheduled Task resources.", + "summary": "Create a new Seo Url resources.", "description": "Available since: 6.0.0.0", - "operationId": "createScheduledTask", + "operationId": "createSeoUrl", "parameters": [ { "name": "_response", @@ -61299,14 +61285,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SeoUrl" } } } }, "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -61318,7 +61304,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -61333,7 +61319,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -61349,14 +61335,14 @@ } } }, - "/search/scheduled-task": { + "/search/seo-url": { "post": { "tags": [ - "Scheduled Task" + "Seo Url" ], - "summary": "Search for the Scheduled Task resources.", + "summary": "Search for the Seo Url resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchScheduledTask", + "operationId": "searchSeoUrl", "parameters": [ { "name": "sw-include-search-info", @@ -61384,7 +61370,7 @@ }, "responses": { "200": { - "description": "List of ScheduledTask", + "description": "List of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -61398,7 +61384,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -61416,7 +61402,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -61433,19 +61419,19 @@ } } }, - "/scheduled-task/{id}": { + "/seo-url/{id}": { "get": { "tags": [ - "Scheduled Task" + "Seo Url" ], - "summary": "Detailed information about a Scheduled Task resource.", + "summary": "Detailed information about a Seo Url resource.", "description": "Available since: 6.0.0.0", - "operationId": "getScheduledTask", + "operationId": "getSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the scheduled_task", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -61455,7 +61441,7 @@ ], "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -61467,7 +61453,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -61482,7 +61468,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -61499,16 +61485,16 @@ }, "delete": { "tags": [ - "Scheduled Task" + "Seo Url" ], - "summary": "Delete a Scheduled Task resource.", + "summary": "Delete a Seo Url resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteScheduledTask", + "operationId": "deleteSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the scheduled_task", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -61539,16 +61525,16 @@ }, "patch": { "tags": [ - "Scheduled Task" + "Seo Url" ], - "summary": "Partially update information about a Scheduled Task resource.", + "summary": "Partially update information about a Seo Url resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateScheduledTask", + "operationId": "updateSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the scheduled_task", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -61566,18 +61552,18 @@ } ], "requestBody": { - "description": "Partially update information about a Scheduled Task resource.", + "description": "Partially update information about a Seo Url resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SeoUrl" } } } }, "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -61589,7 +61575,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -61604,7 +61590,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -61623,14 +61609,14 @@ } } }, - "/aggregate/scheduled-task": { + "/aggregate/seo-url": { "post": { "tags": [ - "Scheduled Task" + "Seo Url" ], - "summary": "Aggregate for the Scheduled Task resources.", + "summary": "Aggregate for the Seo Url resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateScheduledTask", + "operationId": "aggregateSeoUrl", "requestBody": { "required": true, "content": { @@ -61654,7 +61640,7 @@ }, "responses": { "200": { - "description": "List of ScheduledTask", + "description": "List of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -61668,7 +61654,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -61686,7 +61672,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -61703,14 +61689,14 @@ } } }, - "/script": { + "/seo-url-template": { "get": { "tags": [ - "Script" + "Seo Url Template" ], - "summary": "List with basic information of Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "getScriptList", + "summary": "List with basic information of Seo Url Template resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSeoUrlTemplateList", "parameters": [ { "name": "limit", @@ -61739,7 +61725,7 @@ ], "responses": { "200": { - "description": "List of Script resources.", + "description": "List of Seo Url Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -61758,7 +61744,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrlTemplate" } } ] @@ -61772,16 +61758,16 @@ "type": "object", "properties": { "first": { - "example": "/script?limit=25" + "example": "/seo-url-template?limit=25" }, "last": { - "example": "/script?limit=25&page=11" + "example": "/seo-url-template?limit=25&page=11" }, "next": { - "example": "/script?limit=25&page=4" + "example": "/seo-url-template?limit=25&page=4" }, "prev": { - "example": "/script?limit=25&page=2" + "example": "/seo-url-template?limit=25&page=2" } } } @@ -61802,7 +61788,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -61817,11 +61803,11 @@ }, "post": { "tags": [ - "Script" + "Seo Url Template" ], - "summary": "Create a new Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "createScript", + "summary": "Create a new Seo Url Template resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSeoUrlTemplate", "parameters": [ { "name": "_response", @@ -61840,14 +61826,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } }, "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -61859,7 +61845,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -61874,7 +61860,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -61890,14 +61876,14 @@ } } }, - "/search/script": { + "/search/seo-url-template": { "post": { "tags": [ - "Script" + "Seo Url Template" ], - "summary": "Search for the Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "searchScript", + "summary": "Search for the Seo Url Template resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSeoUrlTemplate", "parameters": [ { "name": "sw-include-search-info", @@ -61925,7 +61911,7 @@ }, "responses": { "200": { - "description": "List of Script", + "description": "List of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -61939,7 +61925,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -61957,7 +61943,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -61974,19 +61960,19 @@ } } }, - "/script/{id}": { + "/seo-url-template/{id}": { "get": { "tags": [ - "Script" + "Seo Url Template" ], - "summary": "Detailed information about a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "getScript", + "summary": "Detailed information about a Seo Url Template resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the script", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -61996,7 +61982,7 @@ ], "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -62008,7 +61994,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -62023,7 +62009,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -62040,16 +62026,16 @@ }, "delete": { "tags": [ - "Script" + "Seo Url Template" ], - "summary": "Delete a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "deleteScript", + "summary": "Delete a Seo Url Template resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the script", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -62080,16 +62066,16 @@ }, "patch": { "tags": [ - "Script" + "Seo Url Template" ], - "summary": "Partially update information about a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "updateScript", + "summary": "Partially update information about a Seo Url Template resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the script", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -62107,18 +62093,18 @@ } ], "requestBody": { - "description": "Partially update information about a Script resource.", + "description": "Partially update information about a Seo Url Template resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } }, "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -62130,7 +62116,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -62145,7 +62131,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -62164,14 +62150,14 @@ } } }, - "/aggregate/script": { + "/aggregate/seo-url-template": { "post": { "tags": [ - "Script" + "Seo Url Template" ], - "summary": "Aggregate for the Script resources.", + "summary": "Aggregate for the Seo Url Template resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateScript", + "operationId": "aggregateSeoUrlTemplate", "requestBody": { "required": true, "content": { @@ -62195,7 +62181,7 @@ }, "responses": { "200": { - "description": "List of Script", + "description": "List of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -62209,7 +62195,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -62227,7 +62213,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -62244,14 +62230,14 @@ } } }, - "/seo-url": { + "/shipping-method": { "get": { "tags": [ - "Seo Url" + "Shipping Method" ], - "summary": "List with basic information of Seo Url resources.", + "summary": "List with basic information of Shipping Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlList", + "operationId": "getShippingMethodList", "parameters": [ { "name": "limit", @@ -62280,7 +62266,7 @@ ], "responses": { "200": { - "description": "List of Seo Url resources.", + "description": "List of Shipping Method resources.", "content": { "application/vnd.api+json": { "schema": { @@ -62299,7 +62285,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethod" } } ] @@ -62313,16 +62299,16 @@ "type": "object", "properties": { "first": { - "example": "/seo-url?limit=25" + "example": "/shipping-method?limit=25" }, "last": { - "example": "/seo-url?limit=25&page=11" + "example": "/shipping-method?limit=25&page=11" }, "next": { - "example": "/seo-url?limit=25&page=4" + "example": "/shipping-method?limit=25&page=4" }, "prev": { - "example": "/seo-url?limit=25&page=2" + "example": "/shipping-method?limit=25&page=2" } } } @@ -62343,7 +62329,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -62358,11 +62344,11 @@ }, "post": { "tags": [ - "Seo Url" + "Shipping Method" ], - "summary": "Create a new Seo Url resources.", + "summary": "Create a new Shipping Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSeoUrl", + "operationId": "createShippingMethod", "parameters": [ { "name": "_response", @@ -62381,14 +62367,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethod" } } } }, "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -62400,7 +62386,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -62415,7 +62401,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -62431,14 +62417,14 @@ } } }, - "/search/seo-url": { + "/search/shipping-method": { "post": { "tags": [ - "Seo Url" + "Shipping Method" ], - "summary": "Search for the Seo Url resources.", + "summary": "Search for the Shipping Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSeoUrl", + "operationId": "searchShippingMethod", "parameters": [ { "name": "sw-include-search-info", @@ -62466,7 +62452,7 @@ }, "responses": { "200": { - "description": "List of SeoUrl", + "description": "List of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -62480,7 +62466,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -62498,7 +62484,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -62515,19 +62501,19 @@ } } }, - "/seo-url/{id}": { + "/shipping-method/{id}": { "get": { "tags": [ - "Seo Url" + "Shipping Method" ], - "summary": "Detailed information about a Seo Url resource.", + "summary": "Detailed information about a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrl", + "operationId": "getShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -62537,7 +62523,7 @@ ], "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -62549,7 +62535,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -62564,7 +62550,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -62581,16 +62567,16 @@ }, "delete": { "tags": [ - "Seo Url" + "Shipping Method" ], - "summary": "Delete a Seo Url resource.", + "summary": "Delete a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSeoUrl", + "operationId": "deleteShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -62621,16 +62607,16 @@ }, "patch": { "tags": [ - "Seo Url" + "Shipping Method" ], - "summary": "Partially update information about a Seo Url resource.", + "summary": "Partially update information about a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSeoUrl", + "operationId": "updateShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -62648,18 +62634,18 @@ } ], "requestBody": { - "description": "Partially update information about a Seo Url resource.", + "description": "Partially update information about a Shipping Method resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethod" } } } }, "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -62671,7 +62657,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -62686,7 +62672,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -62705,14 +62691,14 @@ } } }, - "/aggregate/seo-url": { + "/aggregate/shipping-method": { "post": { "tags": [ - "Seo Url" + "Shipping Method" ], - "summary": "Aggregate for the Seo Url resources.", + "summary": "Aggregate for the Shipping Method resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSeoUrl", + "operationId": "aggregateShippingMethod", "requestBody": { "required": true, "content": { @@ -62736,7 +62722,7 @@ }, "responses": { "200": { - "description": "List of SeoUrl", + "description": "List of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -62750,7 +62736,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -62768,7 +62754,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -62785,14 +62771,14 @@ } } }, - "/seo-url-template": { + "/shipping-method-price": { "get": { "tags": [ - "Seo Url Template" + "Shipping Method Price" ], - "summary": "List with basic information of Seo Url Template resources.", + "summary": "List with basic information of Shipping Method Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlTemplateList", + "operationId": "getShippingMethodPriceList", "parameters": [ { "name": "limit", @@ -62821,7 +62807,7 @@ ], "responses": { "200": { - "description": "List of Seo Url Template resources.", + "description": "List of Shipping Method Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -62840,7 +62826,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethodPrice" } } ] @@ -62854,16 +62840,16 @@ "type": "object", "properties": { "first": { - "example": "/seo-url-template?limit=25" + "example": "/shipping-method-price?limit=25" }, "last": { - "example": "/seo-url-template?limit=25&page=11" + "example": "/shipping-method-price?limit=25&page=11" }, "next": { - "example": "/seo-url-template?limit=25&page=4" + "example": "/shipping-method-price?limit=25&page=4" }, "prev": { - "example": "/seo-url-template?limit=25&page=2" + "example": "/shipping-method-price?limit=25&page=2" } } } @@ -62884,7 +62870,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -62899,11 +62885,11 @@ }, "post": { "tags": [ - "Seo Url Template" + "Shipping Method Price" ], - "summary": "Create a new Seo Url Template resources.", + "summary": "Create a new Shipping Method Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSeoUrlTemplate", + "operationId": "createShippingMethodPrice", "parameters": [ { "name": "_response", @@ -62922,14 +62908,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } }, "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -62941,7 +62927,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -62956,7 +62942,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -62972,14 +62958,14 @@ } } }, - "/search/seo-url-template": { + "/search/shipping-method-price": { "post": { "tags": [ - "Seo Url Template" + "Shipping Method Price" ], - "summary": "Search for the Seo Url Template resources.", + "summary": "Search for the Shipping Method Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSeoUrlTemplate", + "operationId": "searchShippingMethodPrice", "parameters": [ { "name": "sw-include-search-info", @@ -63007,7 +62993,7 @@ }, "responses": { "200": { - "description": "List of SeoUrlTemplate", + "description": "List of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -63021,7 +63007,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -63039,7 +63025,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -63056,19 +63042,19 @@ } } }, - "/seo-url-template/{id}": { + "/shipping-method-price/{id}": { "get": { "tags": [ - "Seo Url Template" + "Shipping Method Price" ], - "summary": "Detailed information about a Seo Url Template resource.", + "summary": "Detailed information about a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlTemplate", + "operationId": "getShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url_template", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -63078,7 +63064,7 @@ ], "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -63090,7 +63076,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -63105,7 +63091,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -63122,16 +63108,16 @@ }, "delete": { "tags": [ - "Seo Url Template" + "Shipping Method Price" ], - "summary": "Delete a Seo Url Template resource.", + "summary": "Delete a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSeoUrlTemplate", + "operationId": "deleteShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url_template", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -63162,16 +63148,16 @@ }, "patch": { "tags": [ - "Seo Url Template" + "Shipping Method Price" ], - "summary": "Partially update information about a Seo Url Template resource.", + "summary": "Partially update information about a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSeoUrlTemplate", + "operationId": "updateShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url_template", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -63189,18 +63175,18 @@ } ], "requestBody": { - "description": "Partially update information about a Seo Url Template resource.", + "description": "Partially update information about a Shipping Method Price resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } }, "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -63212,7 +63198,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -63227,7 +63213,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -63246,14 +63232,14 @@ } } }, - "/aggregate/seo-url-template": { + "/aggregate/shipping-method-price": { "post": { "tags": [ - "Seo Url Template" + "Shipping Method Price" ], - "summary": "Aggregate for the Seo Url Template resources.", + "summary": "Aggregate for the Shipping Method Price resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSeoUrlTemplate", + "operationId": "aggregateShippingMethodPrice", "requestBody": { "required": true, "content": { @@ -63277,7 +63263,7 @@ }, "responses": { "200": { - "description": "List of SeoUrlTemplate", + "description": "List of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -63291,7 +63277,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -63309,7 +63295,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -63326,14 +63312,14 @@ } } }, - "/shipping-method": { + "/snippet": { "get": { "tags": [ - "Shipping Method" + "Snippet" ], - "summary": "List with basic information of Shipping Method resources.", + "summary": "List with basic information of Snippet resources.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodList", + "operationId": "getSnippetList", "parameters": [ { "name": "limit", @@ -63362,7 +63348,7 @@ ], "responses": { "200": { - "description": "List of Shipping Method resources.", + "description": "List of Snippet resources.", "content": { "application/vnd.api+json": { "schema": { @@ -63381,7 +63367,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/Snippet" } } ] @@ -63395,16 +63381,16 @@ "type": "object", "properties": { "first": { - "example": "/shipping-method?limit=25" + "example": "/snippet?limit=25" }, "last": { - "example": "/shipping-method?limit=25&page=11" + "example": "/snippet?limit=25&page=11" }, "next": { - "example": "/shipping-method?limit=25&page=4" + "example": "/snippet?limit=25&page=4" }, "prev": { - "example": "/shipping-method?limit=25&page=2" + "example": "/snippet?limit=25&page=2" } } } @@ -63425,7 +63411,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/Snippet" } } } @@ -63440,11 +63426,11 @@ }, "post": { "tags": [ - "Shipping Method" + "Snippet" ], - "summary": "Create a new Shipping Method resources.", + "summary": "Create a new Snippet resources.", "description": "Available since: 6.0.0.0", - "operationId": "createShippingMethod", + "operationId": "createSnippet", "parameters": [ { "name": "_response", @@ -63463,14 +63449,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/Snippet" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -63482,7 +63468,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/Snippet" } } } @@ -63497,7 +63483,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/Snippet" } } } @@ -63513,14 +63499,14 @@ } } }, - "/search/shipping-method": { + "/search/snippet": { "post": { "tags": [ - "Shipping Method" + "Snippet" ], - "summary": "Search for the Shipping Method resources.", + "summary": "Search for the Snippet resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchShippingMethod", + "operationId": "searchSnippet", "parameters": [ { "name": "sw-include-search-info", @@ -63548,7 +63534,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethod", + "description": "List of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -63562,7 +63548,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/Snippet" } } } @@ -63580,7 +63566,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/Snippet" } } } @@ -63597,19 +63583,19 @@ } } }, - "/shipping-method/{id}": { + "/snippet/{id}": { "get": { "tags": [ - "Shipping Method" + "Snippet" ], - "summary": "Detailed information about a Shipping Method resource.", + "summary": "Detailed information about a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethod", + "operationId": "getSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -63619,7 +63605,7 @@ ], "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -63631,7 +63617,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/Snippet" } } } @@ -63646,7 +63632,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/Snippet" } } } @@ -63663,16 +63649,16 @@ }, "delete": { "tags": [ - "Shipping Method" + "Snippet" ], - "summary": "Delete a Shipping Method resource.", + "summary": "Delete a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteShippingMethod", + "operationId": "deleteSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -63703,16 +63689,16 @@ }, "patch": { "tags": [ - "Shipping Method" + "Snippet" ], - "summary": "Partially update information about a Shipping Method resource.", + "summary": "Partially update information about a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateShippingMethod", + "operationId": "updateSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -63730,18 +63716,18 @@ } ], "requestBody": { - "description": "Partially update information about a Shipping Method resource.", + "description": "Partially update information about a Snippet resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/Snippet" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -63753,7 +63739,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/Snippet" } } } @@ -63768,7 +63754,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/Snippet" } } } @@ -63787,14 +63773,14 @@ } } }, - "/aggregate/shipping-method": { + "/aggregate/snippet": { "post": { "tags": [ - "Shipping Method" + "Snippet" ], - "summary": "Aggregate for the Shipping Method resources.", + "summary": "Aggregate for the Snippet resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateShippingMethod", + "operationId": "aggregateSnippet", "requestBody": { "required": true, "content": { @@ -63818,7 +63804,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethod", + "description": "List of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -63832,7 +63818,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/Snippet" } } } @@ -63850,7 +63836,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/Snippet" } } } @@ -63867,14 +63853,14 @@ } } }, - "/shipping-method-price": { + "/snippet-set": { "get": { "tags": [ - "Shipping Method Price" + "Snippet Set" ], - "summary": "List with basic information of Shipping Method Price resources.", + "summary": "List with basic information of Snippet Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodPriceList", + "operationId": "getSnippetSetList", "parameters": [ { "name": "limit", @@ -63903,7 +63889,7 @@ ], "responses": { "200": { - "description": "List of Shipping Method Price resources.", + "description": "List of Snippet Set resources.", "content": { "application/vnd.api+json": { "schema": { @@ -63922,7 +63908,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SnippetSet" } } ] @@ -63936,16 +63922,16 @@ "type": "object", "properties": { "first": { - "example": "/shipping-method-price?limit=25" + "example": "/snippet-set?limit=25" }, "last": { - "example": "/shipping-method-price?limit=25&page=11" + "example": "/snippet-set?limit=25&page=11" }, "next": { - "example": "/shipping-method-price?limit=25&page=4" + "example": "/snippet-set?limit=25&page=4" }, "prev": { - "example": "/shipping-method-price?limit=25&page=2" + "example": "/snippet-set?limit=25&page=2" } } } @@ -63966,7 +63952,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -63981,11 +63967,11 @@ }, "post": { "tags": [ - "Shipping Method Price" + "Snippet Set" ], - "summary": "Create a new Shipping Method Price resources.", + "summary": "Create a new Snippet Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "createShippingMethodPrice", + "operationId": "createSnippetSet", "parameters": [ { "name": "_response", @@ -64004,14 +63990,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SnippetSet" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -64023,7 +64009,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -64038,7 +64024,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -64054,14 +64040,14 @@ } } }, - "/search/shipping-method-price": { + "/search/snippet-set": { "post": { "tags": [ - "Shipping Method Price" + "Snippet Set" ], - "summary": "Search for the Shipping Method Price resources.", + "summary": "Search for the Snippet Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchShippingMethodPrice", + "operationId": "searchSnippetSet", "parameters": [ { "name": "sw-include-search-info", @@ -64089,7 +64075,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethodPrice", + "description": "List of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -64103,7 +64089,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -64121,7 +64107,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -64138,19 +64124,19 @@ } } }, - "/shipping-method-price/{id}": { + "/snippet-set/{id}": { "get": { "tags": [ - "Shipping Method Price" + "Snippet Set" ], - "summary": "Detailed information about a Shipping Method Price resource.", + "summary": "Detailed information about a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodPrice", + "operationId": "getSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -64160,7 +64146,7 @@ ], "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -64172,7 +64158,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -64187,7 +64173,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -64204,16 +64190,16 @@ }, "delete": { "tags": [ - "Shipping Method Price" + "Snippet Set" ], - "summary": "Delete a Shipping Method Price resource.", + "summary": "Delete a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteShippingMethodPrice", + "operationId": "deleteSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -64244,16 +64230,16 @@ }, "patch": { "tags": [ - "Shipping Method Price" + "Snippet Set" ], - "summary": "Partially update information about a Shipping Method Price resource.", + "summary": "Partially update information about a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateShippingMethodPrice", + "operationId": "updateSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -64271,18 +64257,18 @@ } ], "requestBody": { - "description": "Partially update information about a Shipping Method Price resource.", + "description": "Partially update information about a Snippet Set resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SnippetSet" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -64294,7 +64280,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -64309,7 +64295,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -64328,14 +64314,14 @@ } } }, - "/aggregate/shipping-method-price": { + "/aggregate/snippet-set": { "post": { "tags": [ - "Shipping Method Price" + "Snippet Set" ], - "summary": "Aggregate for the Shipping Method Price resources.", + "summary": "Aggregate for the Snippet Set resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateShippingMethodPrice", + "operationId": "aggregateSnippetSet", "requestBody": { "required": true, "content": { @@ -64359,7 +64345,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethodPrice", + "description": "List of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -64373,7 +64359,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -64391,7 +64377,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -64408,14 +64394,14 @@ } } }, - "/snippet": { + "/state-machine": { "get": { "tags": [ - "Snippet" + "State Machine" ], - "summary": "List with basic information of Snippet resources.", + "summary": "List with basic information of State Machine resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetList", + "operationId": "getStateMachineList", "parameters": [ { "name": "limit", @@ -64444,7 +64430,7 @@ ], "responses": { "200": { - "description": "List of Snippet resources.", + "description": "List of State Machine resources.", "content": { "application/vnd.api+json": { "schema": { @@ -64463,7 +64449,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/StateMachine" } } ] @@ -64477,16 +64463,16 @@ "type": "object", "properties": { "first": { - "example": "/snippet?limit=25" + "example": "/state-machine?limit=25" }, "last": { - "example": "/snippet?limit=25&page=11" + "example": "/state-machine?limit=25&page=11" }, "next": { - "example": "/snippet?limit=25&page=4" + "example": "/state-machine?limit=25&page=4" }, "prev": { - "example": "/snippet?limit=25&page=2" + "example": "/state-machine?limit=25&page=2" } } } @@ -64507,7 +64493,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -64522,11 +64508,11 @@ }, "post": { "tags": [ - "Snippet" + "State Machine" ], - "summary": "Create a new Snippet resources.", + "summary": "Create a new State Machine resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSnippet", + "operationId": "createStateMachine", "parameters": [ { "name": "_response", @@ -64545,14 +64531,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/StateMachine" } } } }, "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -64564,7 +64550,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -64579,7 +64565,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -64595,14 +64581,14 @@ } } }, - "/search/snippet": { + "/search/state-machine": { "post": { "tags": [ - "Snippet" + "State Machine" ], - "summary": "Search for the Snippet resources.", + "summary": "Search for the State Machine resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSnippet", + "operationId": "searchStateMachine", "parameters": [ { "name": "sw-include-search-info", @@ -64630,7 +64616,7 @@ }, "responses": { "200": { - "description": "List of Snippet", + "description": "List of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -64644,7 +64630,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -64662,7 +64648,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -64679,19 +64665,19 @@ } } }, - "/snippet/{id}": { + "/state-machine/{id}": { "get": { "tags": [ - "Snippet" + "State Machine" ], - "summary": "Detailed information about a Snippet resource.", + "summary": "Detailed information about a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippet", + "operationId": "getStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -64701,7 +64687,7 @@ ], "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -64713,7 +64699,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -64728,7 +64714,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -64745,16 +64731,16 @@ }, "delete": { "tags": [ - "Snippet" + "State Machine" ], - "summary": "Delete a Snippet resource.", + "summary": "Delete a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSnippet", + "operationId": "deleteStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -64785,16 +64771,16 @@ }, "patch": { "tags": [ - "Snippet" + "State Machine" ], - "summary": "Partially update information about a Snippet resource.", + "summary": "Partially update information about a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSnippet", + "operationId": "updateStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -64812,18 +64798,18 @@ } ], "requestBody": { - "description": "Partially update information about a Snippet resource.", + "description": "Partially update information about a State Machine resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/StateMachine" } } } }, "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -64835,7 +64821,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -64850,7 +64836,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -64869,14 +64855,14 @@ } } }, - "/aggregate/snippet": { + "/aggregate/state-machine": { "post": { "tags": [ - "Snippet" + "State Machine" ], - "summary": "Aggregate for the Snippet resources.", + "summary": "Aggregate for the State Machine resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSnippet", + "operationId": "aggregateStateMachine", "requestBody": { "required": true, "content": { @@ -64900,7 +64886,7 @@ }, "responses": { "200": { - "description": "List of Snippet", + "description": "List of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -64914,7 +64900,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -64932,7 +64918,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -64949,14 +64935,14 @@ } } }, - "/snippet-set": { + "/state-machine-history": { "get": { "tags": [ - "Snippet Set" + "State Machine History" ], - "summary": "List with basic information of Snippet Set resources.", + "summary": "List with basic information of State Machine History resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetSetList", + "operationId": "getStateMachineHistoryList", "parameters": [ { "name": "limit", @@ -64985,7 +64971,7 @@ ], "responses": { "200": { - "description": "List of Snippet Set resources.", + "description": "List of State Machine History resources.", "content": { "application/vnd.api+json": { "schema": { @@ -65004,7 +64990,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachineHistory" } } ] @@ -65018,16 +65004,16 @@ "type": "object", "properties": { "first": { - "example": "/snippet-set?limit=25" + "example": "/state-machine-history?limit=25" }, "last": { - "example": "/snippet-set?limit=25&page=11" + "example": "/state-machine-history?limit=25&page=11" }, "next": { - "example": "/snippet-set?limit=25&page=4" + "example": "/state-machine-history?limit=25&page=4" }, "prev": { - "example": "/snippet-set?limit=25&page=2" + "example": "/state-machine-history?limit=25&page=2" } } } @@ -65048,7 +65034,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -65063,11 +65049,11 @@ }, "post": { "tags": [ - "Snippet Set" + "State Machine History" ], - "summary": "Create a new Snippet Set resources.", + "summary": "Create a new State Machine History resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSnippetSet", + "operationId": "createStateMachineHistory", "parameters": [ { "name": "_response", @@ -65086,14 +65072,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachineHistory" } } } }, "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -65105,7 +65091,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -65120,7 +65106,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -65136,14 +65122,14 @@ } } }, - "/search/snippet-set": { + "/search/state-machine-history": { "post": { "tags": [ - "Snippet Set" + "State Machine History" ], - "summary": "Search for the Snippet Set resources.", + "summary": "Search for the State Machine History resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSnippetSet", + "operationId": "searchStateMachineHistory", "parameters": [ { "name": "sw-include-search-info", @@ -65171,7 +65157,7 @@ }, "responses": { "200": { - "description": "List of SnippetSet", + "description": "List of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -65185,7 +65171,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -65203,7 +65189,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -65220,19 +65206,19 @@ } } }, - "/snippet-set/{id}": { + "/state-machine-history/{id}": { "get": { "tags": [ - "Snippet Set" + "State Machine History" ], - "summary": "Detailed information about a Snippet Set resource.", + "summary": "Detailed information about a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetSet", + "operationId": "getStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -65242,7 +65228,7 @@ ], "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -65254,7 +65240,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -65269,7 +65255,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -65286,16 +65272,16 @@ }, "delete": { "tags": [ - "Snippet Set" + "State Machine History" ], - "summary": "Delete a Snippet Set resource.", + "summary": "Delete a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSnippetSet", + "operationId": "deleteStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -65326,16 +65312,16 @@ }, "patch": { "tags": [ - "Snippet Set" + "State Machine History" ], - "summary": "Partially update information about a Snippet Set resource.", + "summary": "Partially update information about a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSnippetSet", + "operationId": "updateStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -65353,18 +65339,18 @@ } ], "requestBody": { - "description": "Partially update information about a Snippet Set resource.", + "description": "Partially update information about a State Machine History resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachineHistory" } } } }, "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -65376,7 +65362,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -65391,7 +65377,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -65410,14 +65396,14 @@ } } }, - "/aggregate/snippet-set": { + "/aggregate/state-machine-history": { "post": { "tags": [ - "Snippet Set" + "State Machine History" ], - "summary": "Aggregate for the Snippet Set resources.", + "summary": "Aggregate for the State Machine History resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSnippetSet", + "operationId": "aggregateStateMachineHistory", "requestBody": { "required": true, "content": { @@ -65441,7 +65427,7 @@ }, "responses": { "200": { - "description": "List of SnippetSet", + "description": "List of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -65455,7 +65441,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -65473,7 +65459,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -65490,14 +65476,14 @@ } } }, - "/state-machine": { + "/state-machine-state": { "get": { "tags": [ - "State Machine" + "State Machine State" ], - "summary": "List with basic information of State Machine resources.", + "summary": "List with basic information of State Machine State resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineList", + "operationId": "getStateMachineStateList", "parameters": [ { "name": "limit", @@ -65526,7 +65512,7 @@ ], "responses": { "200": { - "description": "List of State Machine resources.", + "description": "List of State Machine State resources.", "content": { "application/vnd.api+json": { "schema": { @@ -65545,7 +65531,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineState" } } ] @@ -65559,16 +65545,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine?limit=25" + "example": "/state-machine-state?limit=25" }, "last": { - "example": "/state-machine?limit=25&page=11" + "example": "/state-machine-state?limit=25&page=11" }, "next": { - "example": "/state-machine?limit=25&page=4" + "example": "/state-machine-state?limit=25&page=4" }, "prev": { - "example": "/state-machine?limit=25&page=2" + "example": "/state-machine-state?limit=25&page=2" } } } @@ -65589,7 +65575,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -65604,11 +65590,11 @@ }, "post": { "tags": [ - "State Machine" + "State Machine State" ], - "summary": "Create a new State Machine resources.", + "summary": "Create a new State Machine State resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachine", + "operationId": "createStateMachineState", "parameters": [ { "name": "_response", @@ -65627,14 +65613,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineState" } } } }, "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -65646,7 +65632,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -65661,7 +65647,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -65677,14 +65663,14 @@ } } }, - "/search/state-machine": { + "/search/state-machine-state": { "post": { "tags": [ - "State Machine" + "State Machine State" ], - "summary": "Search for the State Machine resources.", + "summary": "Search for the State Machine State resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachine", + "operationId": "searchStateMachineState", "parameters": [ { "name": "sw-include-search-info", @@ -65712,7 +65698,7 @@ }, "responses": { "200": { - "description": "List of StateMachine", + "description": "List of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -65726,7 +65712,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -65744,7 +65730,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -65761,19 +65747,19 @@ } } }, - "/state-machine/{id}": { + "/state-machine-state/{id}": { "get": { "tags": [ - "State Machine" + "State Machine State" ], - "summary": "Detailed information about a State Machine resource.", + "summary": "Detailed information about a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachine", + "operationId": "getStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -65783,7 +65769,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -65795,7 +65781,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -65810,7 +65796,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -65827,16 +65813,16 @@ }, "delete": { "tags": [ - "State Machine" + "State Machine State" ], - "summary": "Delete a State Machine resource.", + "summary": "Delete a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachine", + "operationId": "deleteStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -65867,16 +65853,16 @@ }, "patch": { "tags": [ - "State Machine" + "State Machine State" ], - "summary": "Partially update information about a State Machine resource.", + "summary": "Partially update information about a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachine", + "operationId": "updateStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -65894,18 +65880,18 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine resource.", + "description": "Partially update information about a State Machine State resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineState" } } } }, "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -65917,7 +65903,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -65932,7 +65918,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -65951,14 +65937,14 @@ } } }, - "/aggregate/state-machine": { + "/aggregate/state-machine-state": { "post": { "tags": [ - "State Machine" + "State Machine State" ], - "summary": "Aggregate for the State Machine resources.", + "summary": "Aggregate for the State Machine State resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachine", + "operationId": "aggregateStateMachineState", "requestBody": { "required": true, "content": { @@ -65982,7 +65968,7 @@ }, "responses": { "200": { - "description": "List of StateMachine", + "description": "List of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -65996,7 +65982,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -66014,7 +66000,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -66031,14 +66017,14 @@ } } }, - "/state-machine-history": { + "/state-machine-transition": { "get": { "tags": [ - "State Machine History" + "State Machine Transition" ], - "summary": "List with basic information of State Machine History resources.", + "summary": "List with basic information of State Machine Transition resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineHistoryList", + "operationId": "getStateMachineTransitionList", "parameters": [ { "name": "limit", @@ -66067,7 +66053,7 @@ ], "responses": { "200": { - "description": "List of State Machine History resources.", + "description": "List of State Machine Transition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -66086,7 +66072,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineTransition" } } ] @@ -66100,16 +66086,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-history?limit=25" + "example": "/state-machine-transition?limit=25" }, "last": { - "example": "/state-machine-history?limit=25&page=11" + "example": "/state-machine-transition?limit=25&page=11" }, "next": { - "example": "/state-machine-history?limit=25&page=4" + "example": "/state-machine-transition?limit=25&page=4" }, "prev": { - "example": "/state-machine-history?limit=25&page=2" + "example": "/state-machine-transition?limit=25&page=2" } } } @@ -66130,7 +66116,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -66145,11 +66131,11 @@ }, "post": { "tags": [ - "State Machine History" + "State Machine Transition" ], - "summary": "Create a new State Machine History resources.", + "summary": "Create a new State Machine Transition resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineHistory", + "operationId": "createStateMachineTransition", "parameters": [ { "name": "_response", @@ -66168,14 +66154,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineTransition" } } } }, "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -66187,7 +66173,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -66202,7 +66188,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -66218,14 +66204,14 @@ } } }, - "/search/state-machine-history": { + "/search/state-machine-transition": { "post": { "tags": [ - "State Machine History" + "State Machine Transition" ], - "summary": "Search for the State Machine History resources.", + "summary": "Search for the State Machine Transition resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachineHistory", + "operationId": "searchStateMachineTransition", "parameters": [ { "name": "sw-include-search-info", @@ -66253,7 +66239,7 @@ }, "responses": { "200": { - "description": "List of StateMachineHistory", + "description": "List of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -66267,7 +66253,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -66285,7 +66271,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -66302,19 +66288,19 @@ } } }, - "/state-machine-history/{id}": { + "/state-machine-transition/{id}": { "get": { "tags": [ - "State Machine History" + "State Machine Transition" ], - "summary": "Detailed information about a State Machine History resource.", + "summary": "Detailed information about a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineHistory", + "operationId": "getStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -66324,7 +66310,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -66336,7 +66322,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -66351,7 +66337,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -66368,16 +66354,16 @@ }, "delete": { "tags": [ - "State Machine History" + "State Machine Transition" ], - "summary": "Delete a State Machine History resource.", + "summary": "Delete a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineHistory", + "operationId": "deleteStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -66408,16 +66394,16 @@ }, "patch": { "tags": [ - "State Machine History" + "State Machine Transition" ], - "summary": "Partially update information about a State Machine History resource.", + "summary": "Partially update information about a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineHistory", + "operationId": "updateStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -66435,18 +66421,18 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine History resource.", + "description": "Partially update information about a State Machine Transition resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineTransition" } } } }, "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -66458,7 +66444,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -66473,7 +66459,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -66492,14 +66478,14 @@ } } }, - "/aggregate/state-machine-history": { + "/aggregate/state-machine-transition": { "post": { "tags": [ - "State Machine History" + "State Machine Transition" ], - "summary": "Aggregate for the State Machine History resources.", + "summary": "Aggregate for the State Machine Transition resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineHistory", + "operationId": "aggregateStateMachineTransition", "requestBody": { "required": true, "content": { @@ -66523,7 +66509,7 @@ }, "responses": { "200": { - "description": "List of StateMachineHistory", + "description": "List of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -66537,7 +66523,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -66555,7 +66541,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -66572,14 +66558,14 @@ } } }, - "/state-machine-state": { + "/system-config": { "get": { "tags": [ - "State Machine State" + "System Config" ], - "summary": "List with basic information of State Machine State resources.", + "summary": "List with basic information of System Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineStateList", + "operationId": "getSystemConfigList", "parameters": [ { "name": "limit", @@ -66608,7 +66594,7 @@ ], "responses": { "200": { - "description": "List of State Machine State resources.", + "description": "List of System Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -66627,7 +66613,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/SystemConfig" } } ] @@ -66641,16 +66627,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-state?limit=25" + "example": "/system-config?limit=25" }, "last": { - "example": "/state-machine-state?limit=25&page=11" + "example": "/system-config?limit=25&page=11" }, "next": { - "example": "/state-machine-state?limit=25&page=4" + "example": "/system-config?limit=25&page=4" }, "prev": { - "example": "/state-machine-state?limit=25&page=2" + "example": "/system-config?limit=25&page=2" } } } @@ -66671,7 +66657,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -66686,11 +66672,11 @@ }, "post": { "tags": [ - "State Machine State" + "System Config" ], - "summary": "Create a new State Machine State resources.", + "summary": "Create a new System Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineState", + "operationId": "createSystemConfig", "parameters": [ { "name": "_response", @@ -66709,14 +66695,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/SystemConfig" } } } }, "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -66728,7 +66714,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -66743,7 +66729,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -66759,14 +66745,14 @@ } } }, - "/search/state-machine-state": { + "/search/system-config": { "post": { "tags": [ - "State Machine State" + "System Config" ], - "summary": "Search for the State Machine State resources.", + "summary": "Search for the System Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachineState", + "operationId": "searchSystemConfig", "parameters": [ { "name": "sw-include-search-info", @@ -66794,7 +66780,7 @@ }, "responses": { "200": { - "description": "List of StateMachineState", + "description": "List of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -66808,7 +66794,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -66826,7 +66812,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -66843,19 +66829,19 @@ } } }, - "/state-machine-state/{id}": { + "/system-config/{id}": { "get": { "tags": [ - "State Machine State" + "System Config" ], - "summary": "Detailed information about a State Machine State resource.", + "summary": "Detailed information about a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineState", + "operationId": "getSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -66865,7 +66851,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -66877,7 +66863,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -66892,7 +66878,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -66909,16 +66895,16 @@ }, "delete": { "tags": [ - "State Machine State" + "System Config" ], - "summary": "Delete a State Machine State resource.", + "summary": "Delete a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineState", + "operationId": "deleteSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -66949,16 +66935,16 @@ }, "patch": { "tags": [ - "State Machine State" + "System Config" ], - "summary": "Partially update information about a State Machine State resource.", + "summary": "Partially update information about a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineState", + "operationId": "updateSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -66976,18 +66962,18 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine State resource.", + "description": "Partially update information about a System Config resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/SystemConfig" } } } }, "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -66999,7 +66985,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -67014,7 +67000,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -67033,14 +67019,14 @@ } } }, - "/aggregate/state-machine-state": { + "/aggregate/system-config": { "post": { "tags": [ - "State Machine State" + "System Config" ], - "summary": "Aggregate for the State Machine State resources.", + "summary": "Aggregate for the System Config resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineState", + "operationId": "aggregateSystemConfig", "requestBody": { "required": true, "content": { @@ -67064,7 +67050,7 @@ }, "responses": { "200": { - "description": "List of StateMachineState", + "description": "List of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -67078,7 +67064,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -67096,7 +67082,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -67113,14 +67099,14 @@ } } }, - "/state-machine-transition": { + "/tag": { "get": { "tags": [ - "State Machine Transition" + "Tag" ], - "summary": "List with basic information of State Machine Transition resources.", + "summary": "List with basic information of Tag resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineTransitionList", + "operationId": "getTagList", "parameters": [ { "name": "limit", @@ -67149,7 +67135,7 @@ ], "responses": { "200": { - "description": "List of State Machine Transition resources.", + "description": "List of Tag resources.", "content": { "application/vnd.api+json": { "schema": { @@ -67168,7 +67154,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/Tag" } } ] @@ -67182,16 +67168,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-transition?limit=25" + "example": "/tag?limit=25" }, "last": { - "example": "/state-machine-transition?limit=25&page=11" + "example": "/tag?limit=25&page=11" }, "next": { - "example": "/state-machine-transition?limit=25&page=4" + "example": "/tag?limit=25&page=4" }, "prev": { - "example": "/state-machine-transition?limit=25&page=2" + "example": "/tag?limit=25&page=2" } } } @@ -67212,7 +67198,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/Tag" } } } @@ -67227,11 +67213,11 @@ }, "post": { "tags": [ - "State Machine Transition" + "Tag" ], - "summary": "Create a new State Machine Transition resources.", + "summary": "Create a new Tag resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineTransition", + "operationId": "createTag", "parameters": [ { "name": "_response", @@ -67250,14 +67236,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/Tag" } } } }, "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -67269,7 +67255,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/Tag" } } } @@ -67284,7 +67270,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/Tag" } } } @@ -67300,14 +67286,14 @@ } } }, - "/search/state-machine-transition": { + "/search/tag": { "post": { "tags": [ - "State Machine Transition" + "Tag" ], - "summary": "Search for the State Machine Transition resources.", + "summary": "Search for the Tag resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachineTransition", + "operationId": "searchTag", "parameters": [ { "name": "sw-include-search-info", @@ -67335,7 +67321,7 @@ }, "responses": { "200": { - "description": "List of StateMachineTransition", + "description": "List of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -67349,7 +67335,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/Tag" } } } @@ -67367,7 +67353,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/Tag" } } } @@ -67384,19 +67370,19 @@ } } }, - "/state-machine-transition/{id}": { + "/tag/{id}": { "get": { "tags": [ - "State Machine Transition" + "Tag" ], - "summary": "Detailed information about a State Machine Transition resource.", + "summary": "Detailed information about a Tag resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineTransition", + "operationId": "getTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -67406,7 +67392,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -67418,7 +67404,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/Tag" } } } @@ -67433,7 +67419,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/Tag" } } } @@ -67450,16 +67436,16 @@ }, "delete": { "tags": [ - "State Machine Transition" + "Tag" ], - "summary": "Delete a State Machine Transition resource.", + "summary": "Delete a Tag resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineTransition", + "operationId": "deleteTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -67490,16 +67476,16 @@ }, "patch": { "tags": [ - "State Machine Transition" + "Tag" ], - "summary": "Partially update information about a State Machine Transition resource.", + "summary": "Partially update information about a Tag resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineTransition", + "operationId": "updateTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -67517,18 +67503,18 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine Transition resource.", + "description": "Partially update information about a Tag resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/Tag" } } } }, "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -67540,7 +67526,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/Tag" } } } @@ -67555,7 +67541,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/Tag" } } } @@ -67574,14 +67560,14 @@ } } }, - "/aggregate/state-machine-transition": { + "/aggregate/tag": { "post": { "tags": [ - "State Machine Transition" + "Tag" ], - "summary": "Aggregate for the State Machine Transition resources.", + "summary": "Aggregate for the Tag resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineTransition", + "operationId": "aggregateTag", "requestBody": { "required": true, "content": { @@ -67605,7 +67591,7 @@ }, "responses": { "200": { - "description": "List of StateMachineTransition", + "description": "List of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -67619,7 +67605,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/Tag" } } } @@ -67637,7 +67623,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/Tag" } } } @@ -67654,14 +67640,14 @@ } } }, - "/system-config": { + "/tax": { "get": { "tags": [ - "System Config" + "Tax" ], - "summary": "List with basic information of System Config resources.", + "summary": "List with basic information of Tax resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSystemConfigList", + "operationId": "getTaxList", "parameters": [ { "name": "limit", @@ -67690,7 +67676,7 @@ ], "responses": { "200": { - "description": "List of System Config resources.", + "description": "List of Tax resources.", "content": { "application/vnd.api+json": { "schema": { @@ -67709,7 +67695,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tax" } } ] @@ -67723,16 +67709,16 @@ "type": "object", "properties": { "first": { - "example": "/system-config?limit=25" + "example": "/tax?limit=25" }, "last": { - "example": "/system-config?limit=25&page=11" + "example": "/tax?limit=25&page=11" }, "next": { - "example": "/system-config?limit=25&page=4" + "example": "/tax?limit=25&page=4" }, "prev": { - "example": "/system-config?limit=25&page=2" + "example": "/tax?limit=25&page=2" } } } @@ -67753,7 +67739,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tax" } } } @@ -67768,11 +67754,11 @@ }, "post": { "tags": [ - "System Config" + "Tax" ], - "summary": "Create a new System Config resources.", + "summary": "Create a new Tax resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSystemConfig", + "operationId": "createTax", "parameters": [ { "name": "_response", @@ -67791,14 +67777,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tax" } } } }, "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -67810,7 +67796,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tax" } } } @@ -67825,7 +67811,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tax" } } } @@ -67841,14 +67827,14 @@ } } }, - "/search/system-config": { + "/search/tax": { "post": { "tags": [ - "System Config" + "Tax" ], - "summary": "Search for the System Config resources.", + "summary": "Search for the Tax resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSystemConfig", + "operationId": "searchTax", "parameters": [ { "name": "sw-include-search-info", @@ -67876,7 +67862,7 @@ }, "responses": { "200": { - "description": "List of SystemConfig", + "description": "List of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -67890,7 +67876,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tax" } } } @@ -67908,7 +67894,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tax" } } } @@ -67925,19 +67911,19 @@ } } }, - "/system-config/{id}": { + "/tax/{id}": { "get": { "tags": [ - "System Config" + "Tax" ], - "summary": "Detailed information about a System Config resource.", + "summary": "Detailed information about a Tax resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSystemConfig", + "operationId": "getTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -67947,7 +67933,7 @@ ], "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -67959,7 +67945,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tax" } } } @@ -67974,7 +67960,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tax" } } } @@ -67991,16 +67977,16 @@ }, "delete": { "tags": [ - "System Config" + "Tax" ], - "summary": "Delete a System Config resource.", + "summary": "Delete a Tax resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSystemConfig", + "operationId": "deleteTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -68031,16 +68017,16 @@ }, "patch": { "tags": [ - "System Config" + "Tax" ], - "summary": "Partially update information about a System Config resource.", + "summary": "Partially update information about a Tax resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSystemConfig", + "operationId": "updateTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -68058,18 +68044,18 @@ } ], "requestBody": { - "description": "Partially update information about a System Config resource.", + "description": "Partially update information about a Tax resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tax" } } } }, "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -68081,7 +68067,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tax" } } } @@ -68096,7 +68082,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tax" } } } @@ -68115,14 +68101,14 @@ } } }, - "/aggregate/system-config": { + "/aggregate/tax": { "post": { "tags": [ - "System Config" + "Tax" ], - "summary": "Aggregate for the System Config resources.", + "summary": "Aggregate for the Tax resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSystemConfig", + "operationId": "aggregateTax", "requestBody": { "required": true, "content": { @@ -68146,7 +68132,7 @@ }, "responses": { "200": { - "description": "List of SystemConfig", + "description": "List of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -68160,7 +68146,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tax" } } } @@ -68178,7 +68164,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tax" } } } @@ -68195,14 +68181,14 @@ } } }, - "/tag": { + "/tax-provider": { "get": { "tags": [ - "Tag" + "Tax Provider" ], - "summary": "List with basic information of Tag resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getTagList", + "summary": "List with basic information of Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "getTaxProviderList", "parameters": [ { "name": "limit", @@ -68231,7 +68217,7 @@ ], "responses": { "200": { - "description": "List of Tag resources.", + "description": "List of Tax Provider resources.", "content": { "application/vnd.api+json": { "schema": { @@ -68250,7 +68236,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/TaxProvider" } } ] @@ -68264,16 +68250,16 @@ "type": "object", "properties": { "first": { - "example": "/tag?limit=25" + "example": "/tax-provider?limit=25" }, "last": { - "example": "/tag?limit=25&page=11" + "example": "/tax-provider?limit=25&page=11" }, "next": { - "example": "/tag?limit=25&page=4" + "example": "/tax-provider?limit=25&page=4" }, "prev": { - "example": "/tag?limit=25&page=2" + "example": "/tax-provider?limit=25&page=2" } } } @@ -68294,7 +68280,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -68309,11 +68295,11 @@ }, "post": { "tags": [ - "Tag" + "Tax Provider" ], - "summary": "Create a new Tag resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createTag", + "summary": "Create a new Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "createTaxProvider", "parameters": [ { "name": "_response", @@ -68332,14 +68318,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/TaxProvider" } } } }, "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -68351,7 +68337,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -68366,7 +68352,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -68382,14 +68368,14 @@ } } }, - "/search/tag": { + "/search/tax-provider": { "post": { "tags": [ - "Tag" + "Tax Provider" ], - "summary": "Search for the Tag resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchTag", + "summary": "Search for the Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "searchTaxProvider", "parameters": [ { "name": "sw-include-search-info", @@ -68417,7 +68403,7 @@ }, "responses": { "200": { - "description": "List of Tag", + "description": "List of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -68431,7 +68417,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -68449,7 +68435,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -68466,19 +68452,19 @@ } } }, - "/tag/{id}": { + "/tax-provider/{id}": { "get": { "tags": [ - "Tag" + "Tax Provider" ], - "summary": "Detailed information about a Tag resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getTag", + "summary": "Detailed information about a Tax Provider resource.", + "description": "Available since: 6.5.0.0", + "operationId": "getTaxProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -68488,7 +68474,7 @@ ], "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -68500,7 +68486,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -68515,7 +68501,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -68532,16 +68518,16 @@ }, "delete": { "tags": [ - "Tag" + "Tax Provider" ], - "summary": "Delete a Tag resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteTag", + "summary": "Delete a Tax Provider resource.", + "description": "Available since: 6.5.0.0", + "operationId": "deleteTaxProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -68572,16 +68558,16 @@ }, "patch": { "tags": [ - "Tag" + "Tax Provider" ], - "summary": "Partially update information about a Tag resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateTag", + "summary": "Partially update information about a Tax Provider resource.", + "description": "Available since: 6.5.0.0", + "operationId": "updateTaxProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -68599,18 +68585,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tag resource.", + "description": "Partially update information about a Tax Provider resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/TaxProvider" } } } }, "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -68622,7 +68608,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -68637,7 +68623,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -68656,14 +68642,14 @@ } } }, - "/aggregate/tag": { + "/aggregate/tax-provider": { "post": { "tags": [ - "Tag" + "Tax Provider" ], - "summary": "Aggregate for the Tag resources.", + "summary": "Aggregate for the Tax Provider resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTag", + "operationId": "aggregateTaxProvider", "requestBody": { "required": true, "content": { @@ -68687,7 +68673,7 @@ }, "responses": { "200": { - "description": "List of Tag", + "description": "List of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -68701,7 +68687,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -68719,7 +68705,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -68736,14 +68722,14 @@ } } }, - "/tax": { + "/tax-rule": { "get": { "tags": [ - "Tax" + "Tax Rule" ], - "summary": "List with basic information of Tax resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getTaxList", + "summary": "List with basic information of Tax Rule resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getTaxRuleList", "parameters": [ { "name": "limit", @@ -68772,7 +68758,7 @@ ], "responses": { "200": { - "description": "List of Tax resources.", + "description": "List of Tax Rule resources.", "content": { "application/vnd.api+json": { "schema": { @@ -68791,7 +68777,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxRule" } } ] @@ -68805,16 +68791,16 @@ "type": "object", "properties": { "first": { - "example": "/tax?limit=25" + "example": "/tax-rule?limit=25" }, "last": { - "example": "/tax?limit=25&page=11" + "example": "/tax-rule?limit=25&page=11" }, "next": { - "example": "/tax?limit=25&page=4" + "example": "/tax-rule?limit=25&page=4" }, "prev": { - "example": "/tax?limit=25&page=2" + "example": "/tax-rule?limit=25&page=2" } } } @@ -68835,7 +68821,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxRule" } } } @@ -68850,11 +68836,11 @@ }, "post": { "tags": [ - "Tax" + "Tax Rule" ], - "summary": "Create a new Tax resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createTax", + "summary": "Create a new Tax Rule resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createTaxRule", "parameters": [ { "name": "_response", @@ -68873,14 +68859,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxRule" } } } }, "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -68892,7 +68878,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxRule" } } } @@ -68907,7 +68893,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxRule" } } } @@ -68923,14 +68909,14 @@ } } }, - "/search/tax": { + "/search/tax-rule": { "post": { "tags": [ - "Tax" + "Tax Rule" ], - "summary": "Search for the Tax resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchTax", + "summary": "Search for the Tax Rule resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchTaxRule", "parameters": [ { "name": "sw-include-search-info", @@ -68958,7 +68944,7 @@ }, "responses": { "200": { - "description": "List of Tax", + "description": "List of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -68972,7 +68958,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxRule" } } } @@ -68990,7 +68976,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxRule" } } } @@ -69007,19 +68993,19 @@ } } }, - "/tax/{id}": { + "/tax-rule/{id}": { "get": { "tags": [ - "Tax" + "Tax Rule" ], - "summary": "Detailed information about a Tax resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getTax", + "summary": "Detailed information about a Tax Rule resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getTaxRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -69029,7 +69015,7 @@ ], "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -69041,7 +69027,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxRule" } } } @@ -69056,7 +69042,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxRule" } } } @@ -69073,16 +69059,16 @@ }, "delete": { "tags": [ - "Tax" + "Tax Rule" ], - "summary": "Delete a Tax resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteTax", + "summary": "Delete a Tax Rule resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteTaxRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -69113,16 +69099,16 @@ }, "patch": { "tags": [ - "Tax" + "Tax Rule" ], - "summary": "Partially update information about a Tax resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateTax", + "summary": "Partially update information about a Tax Rule resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateTaxRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -69140,18 +69126,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tax resource.", + "description": "Partially update information about a Tax Rule resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxRule" } } } }, "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -69163,7 +69149,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxRule" } } } @@ -69178,7 +69164,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxRule" } } } @@ -69197,14 +69183,14 @@ } } }, - "/aggregate/tax": { + "/aggregate/tax-rule": { "post": { "tags": [ - "Tax" + "Tax Rule" ], - "summary": "Aggregate for the Tax resources.", + "summary": "Aggregate for the Tax Rule resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTax", + "operationId": "aggregateTaxRule", "requestBody": { "required": true, "content": { @@ -69228,7 +69214,7 @@ }, "responses": { "200": { - "description": "List of Tax", + "description": "List of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -69242,7 +69228,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxRule" } } } @@ -69260,7 +69246,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxRule" } } } @@ -69277,14 +69263,14 @@ } } }, - "/tax-provider": { + "/tax-rule-type": { "get": { "tags": [ - "Tax Provider" + "Tax Rule Type" ], - "summary": "List with basic information of Tax Provider resources.", - "description": "Available since: 6.5.0.0", - "operationId": "getTaxProviderList", + "summary": "List with basic information of Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getTaxRuleTypeList", "parameters": [ { "name": "limit", @@ -69313,7 +69299,7 @@ ], "responses": { "200": { - "description": "List of Tax Provider resources.", + "description": "List of Tax Rule Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -69332,7 +69318,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRuleType" } } ] @@ -69346,16 +69332,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-provider?limit=25" + "example": "/tax-rule-type?limit=25" }, "last": { - "example": "/tax-provider?limit=25&page=11" + "example": "/tax-rule-type?limit=25&page=11" }, "next": { - "example": "/tax-provider?limit=25&page=4" + "example": "/tax-rule-type?limit=25&page=4" }, "prev": { - "example": "/tax-provider?limit=25&page=2" + "example": "/tax-rule-type?limit=25&page=2" } } } @@ -69376,7 +69362,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -69391,11 +69377,11 @@ }, "post": { "tags": [ - "Tax Provider" + "Tax Rule Type" ], - "summary": "Create a new Tax Provider resources.", - "description": "Available since: 6.5.0.0", - "operationId": "createTaxProvider", + "summary": "Create a new Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createTaxRuleType", "parameters": [ { "name": "_response", @@ -69414,14 +69400,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRuleType" } } } }, "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -69433,7 +69419,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -69448,7 +69434,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -69464,14 +69450,14 @@ } } }, - "/search/tax-provider": { + "/search/tax-rule-type": { "post": { "tags": [ - "Tax Provider" + "Tax Rule Type" ], - "summary": "Search for the Tax Provider resources.", - "description": "Available since: 6.5.0.0", - "operationId": "searchTaxProvider", + "summary": "Search for the Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchTaxRuleType", "parameters": [ { "name": "sw-include-search-info", @@ -69499,7 +69485,7 @@ }, "responses": { "200": { - "description": "List of TaxProvider", + "description": "List of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -69513,7 +69499,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -69531,7 +69517,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -69548,19 +69534,19 @@ } } }, - "/tax-provider/{id}": { + "/tax-rule-type/{id}": { "get": { "tags": [ - "Tax Provider" + "Tax Rule Type" ], - "summary": "Detailed information about a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "getTaxProvider", + "summary": "Detailed information about a Tax Rule Type resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getTaxRuleType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_provider", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -69570,7 +69556,7 @@ ], "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -69582,7 +69568,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -69597,7 +69583,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -69614,16 +69600,16 @@ }, "delete": { "tags": [ - "Tax Provider" + "Tax Rule Type" ], - "summary": "Delete a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "deleteTaxProvider", + "summary": "Delete a Tax Rule Type resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteTaxRuleType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_provider", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -69654,16 +69640,16 @@ }, "patch": { "tags": [ - "Tax Provider" + "Tax Rule Type" ], - "summary": "Partially update information about a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "updateTaxProvider", + "summary": "Partially update information about a Tax Rule Type resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateTaxRuleType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_provider", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -69681,18 +69667,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Provider resource.", + "description": "Partially update information about a Tax Rule Type resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRuleType" } } } }, "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -69704,7 +69690,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -69719,7 +69705,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -69738,14 +69724,14 @@ } } }, - "/aggregate/tax-provider": { + "/aggregate/tax-rule-type": { "post": { "tags": [ - "Tax Provider" + "Tax Rule Type" ], - "summary": "Aggregate for the Tax Provider resources.", + "summary": "Aggregate for the Tax Rule Type resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxProvider", + "operationId": "aggregateTaxRuleType", "requestBody": { "required": true, "content": { @@ -69769,7 +69755,7 @@ }, "responses": { "200": { - "description": "List of TaxProvider", + "description": "List of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -69783,7 +69769,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -69801,7 +69787,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -69818,14 +69804,14 @@ } } }, - "/tax-rule": { + "/theme": { "get": { "tags": [ - "Tax Rule" + "Theme" ], - "summary": "List with basic information of Tax Rule resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleList", + "summary": "List with basic information of Theme resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getThemeList", "parameters": [ { "name": "limit", @@ -69854,7 +69840,7 @@ ], "responses": { "200": { - "description": "List of Tax Rule resources.", + "description": "List of Theme resources.", "content": { "application/vnd.api+json": { "schema": { @@ -69873,7 +69859,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Theme" } } ] @@ -69887,16 +69873,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-rule?limit=25" + "example": "/theme?limit=25" }, "last": { - "example": "/tax-rule?limit=25&page=11" + "example": "/theme?limit=25&page=11" }, "next": { - "example": "/tax-rule?limit=25&page=4" + "example": "/theme?limit=25&page=4" }, "prev": { - "example": "/tax-rule?limit=25&page=2" + "example": "/theme?limit=25&page=2" } } } @@ -69917,7 +69903,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Theme" } } } @@ -69932,11 +69918,11 @@ }, "post": { "tags": [ - "Tax Rule" + "Theme" ], - "summary": "Create a new Tax Rule resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createTaxRule", + "summary": "Create a new Theme resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createTheme", "parameters": [ { "name": "_response", @@ -69955,14 +69941,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Theme" } } } }, "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -69974,7 +69960,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Theme" } } } @@ -69989,7 +69975,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Theme" } } } @@ -70005,14 +69991,14 @@ } } }, - "/search/tax-rule": { + "/search/theme": { "post": { "tags": [ - "Tax Rule" + "Theme" ], - "summary": "Search for the Tax Rule resources.", - "description": "Available since: 6.1.0.0", - "operationId": "searchTaxRule", + "summary": "Search for the Theme resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchTheme", "parameters": [ { "name": "sw-include-search-info", @@ -70040,7 +70026,7 @@ }, "responses": { "200": { - "description": "List of TaxRule", + "description": "List of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -70054,7 +70040,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Theme" } } } @@ -70072,7 +70058,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Theme" } } } @@ -70089,19 +70075,19 @@ } } }, - "/tax-rule/{id}": { + "/theme/{id}": { "get": { "tags": [ - "Tax Rule" + "Theme" ], - "summary": "Detailed information about a Tax Rule resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getTaxRule", + "summary": "Detailed information about a Theme resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getTheme", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -70111,7 +70097,7 @@ ], "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -70123,7 +70109,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Theme" } } } @@ -70138,7 +70124,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Theme" } } } @@ -70155,16 +70141,16 @@ }, "delete": { "tags": [ - "Tax Rule" + "Theme" ], - "summary": "Delete a Tax Rule resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteTaxRule", + "summary": "Delete a Theme resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteTheme", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -70195,16 +70181,16 @@ }, "patch": { "tags": [ - "Tax Rule" + "Theme" ], - "summary": "Partially update information about a Tax Rule resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateTaxRule", + "summary": "Partially update information about a Theme resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateTheme", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -70222,18 +70208,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Rule resource.", + "description": "Partially update information about a Theme resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Theme" } } } }, "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -70245,7 +70231,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Theme" } } } @@ -70260,7 +70246,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Theme" } } } @@ -70279,14 +70265,14 @@ } } }, - "/aggregate/tax-rule": { + "/aggregate/theme": { "post": { "tags": [ - "Tax Rule" + "Theme" ], - "summary": "Aggregate for the Tax Rule resources.", + "summary": "Aggregate for the Theme resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxRule", + "operationId": "aggregateTheme", "requestBody": { "required": true, "content": { @@ -70310,7 +70296,7 @@ }, "responses": { "200": { - "description": "List of TaxRule", + "description": "List of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -70324,7 +70310,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Theme" } } } @@ -70342,7 +70328,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Theme" } } } @@ -70359,14 +70345,14 @@ } } }, - "/tax-rule-type": { + "/unit": { "get": { "tags": [ - "Tax Rule Type" + "Unit" ], - "summary": "List with basic information of Tax Rule Type resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleTypeList", + "summary": "List with basic information of Unit resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getUnitList", "parameters": [ { "name": "limit", @@ -70395,7 +70381,7 @@ ], "responses": { "200": { - "description": "List of Tax Rule Type resources.", + "description": "List of Unit resources.", "content": { "application/vnd.api+json": { "schema": { @@ -70414,7 +70400,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Unit" } } ] @@ -70428,16 +70414,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-rule-type?limit=25" + "example": "/unit?limit=25" }, "last": { - "example": "/tax-rule-type?limit=25&page=11" + "example": "/unit?limit=25&page=11" }, "next": { - "example": "/tax-rule-type?limit=25&page=4" + "example": "/unit?limit=25&page=4" }, "prev": { - "example": "/tax-rule-type?limit=25&page=2" + "example": "/unit?limit=25&page=2" } } } @@ -70458,7 +70444,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Unit" } } } @@ -70473,11 +70459,11 @@ }, "post": { "tags": [ - "Tax Rule Type" + "Unit" ], - "summary": "Create a new Tax Rule Type resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createTaxRuleType", + "summary": "Create a new Unit resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createUnit", "parameters": [ { "name": "_response", @@ -70496,14 +70482,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Unit" } } } }, "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -70515,7 +70501,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Unit" } } } @@ -70530,7 +70516,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Unit" } } } @@ -70546,14 +70532,14 @@ } } }, - "/search/tax-rule-type": { + "/search/unit": { "post": { "tags": [ - "Tax Rule Type" + "Unit" ], - "summary": "Search for the Tax Rule Type resources.", - "description": "Available since: 6.1.0.0", - "operationId": "searchTaxRuleType", + "summary": "Search for the Unit resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchUnit", "parameters": [ { "name": "sw-include-search-info", @@ -70581,7 +70567,7 @@ }, "responses": { "200": { - "description": "List of TaxRuleType", + "description": "List of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -70595,7 +70581,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Unit" } } } @@ -70613,7 +70599,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Unit" } } } @@ -70630,19 +70616,19 @@ } } }, - "/tax-rule-type/{id}": { + "/unit/{id}": { "get": { "tags": [ - "Tax Rule Type" + "Unit" ], - "summary": "Detailed information about a Tax Rule Type resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleType", + "summary": "Detailed information about a Unit resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule_type", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -70652,7 +70638,7 @@ ], "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -70664,7 +70650,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Unit" } } } @@ -70679,7 +70665,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Unit" } } } @@ -70696,16 +70682,16 @@ }, "delete": { "tags": [ - "Tax Rule Type" + "Unit" ], - "summary": "Delete a Tax Rule Type resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteTaxRuleType", + "summary": "Delete a Unit resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule_type", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -70736,16 +70722,16 @@ }, "patch": { "tags": [ - "Tax Rule Type" + "Unit" ], - "summary": "Partially update information about a Tax Rule Type resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateTaxRuleType", + "summary": "Partially update information about a Unit resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule_type", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -70763,18 +70749,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Rule Type resource.", + "description": "Partially update information about a Unit resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Unit" } } } }, "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -70786,7 +70772,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Unit" } } } @@ -70801,7 +70787,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Unit" } } } @@ -70820,14 +70806,14 @@ } } }, - "/aggregate/tax-rule-type": { + "/aggregate/unit": { "post": { "tags": [ - "Tax Rule Type" + "Unit" ], - "summary": "Aggregate for the Tax Rule Type resources.", + "summary": "Aggregate for the Unit resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxRuleType", + "operationId": "aggregateUnit", "requestBody": { "required": true, "content": { @@ -70851,7 +70837,7 @@ }, "responses": { "200": { - "description": "List of TaxRuleType", + "description": "List of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -70865,7 +70851,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Unit" } } } @@ -70883,7 +70869,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Unit" } } } @@ -70900,14 +70886,14 @@ } } }, - "/theme": { + "/user": { "get": { "tags": [ - "Theme" + "User" ], - "summary": "List with basic information of Theme resources.", + "summary": "List with basic information of User resources.", "description": "Available since: 6.0.0.0", - "operationId": "getThemeList", + "operationId": "getUserList", "parameters": [ { "name": "limit", @@ -70936,7 +70922,7 @@ ], "responses": { "200": { - "description": "List of Theme resources.", + "description": "List of User resources.", "content": { "application/vnd.api+json": { "schema": { @@ -70955,7 +70941,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/User" } } ] @@ -70969,16 +70955,16 @@ "type": "object", "properties": { "first": { - "example": "/theme?limit=25" + "example": "/user?limit=25" }, "last": { - "example": "/theme?limit=25&page=11" + "example": "/user?limit=25&page=11" }, "next": { - "example": "/theme?limit=25&page=4" + "example": "/user?limit=25&page=4" }, "prev": { - "example": "/theme?limit=25&page=2" + "example": "/user?limit=25&page=2" } } } @@ -70999,7 +70985,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/User" } } } @@ -71014,11 +71000,11 @@ }, "post": { "tags": [ - "Theme" + "User" ], - "summary": "Create a new Theme resources.", + "summary": "Create a new User resources.", "description": "Available since: 6.0.0.0", - "operationId": "createTheme", + "operationId": "createUser", "parameters": [ { "name": "_response", @@ -71037,14 +71023,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -71056,7 +71042,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/User" } } } @@ -71071,7 +71057,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/User" } } } @@ -71087,14 +71073,14 @@ } } }, - "/search/theme": { + "/search/user": { "post": { "tags": [ - "Theme" + "User" ], - "summary": "Search for the Theme resources.", + "summary": "Search for the User resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchTheme", + "operationId": "searchUser", "parameters": [ { "name": "sw-include-search-info", @@ -71122,7 +71108,7 @@ }, "responses": { "200": { - "description": "List of Theme", + "description": "List of User", "content": { "application/vnd.api+json": { "schema": { @@ -71136,7 +71122,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/User" } } } @@ -71154,7 +71140,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/User" } } } @@ -71171,19 +71157,19 @@ } } }, - "/theme/{id}": { + "/user/{id}": { "get": { "tags": [ - "Theme" + "User" ], - "summary": "Detailed information about a Theme resource.", + "summary": "Detailed information about a User resource.", "description": "Available since: 6.0.0.0", - "operationId": "getTheme", + "operationId": "getUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the theme", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -71193,7 +71179,7 @@ ], "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -71205,7 +71191,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/User" } } } @@ -71220,7 +71206,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/User" } } } @@ -71237,16 +71223,16 @@ }, "delete": { "tags": [ - "Theme" + "User" ], - "summary": "Delete a Theme resource.", + "summary": "Delete a User resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteTheme", + "operationId": "deleteUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the theme", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -71277,16 +71263,16 @@ }, "patch": { "tags": [ - "Theme" + "User" ], - "summary": "Partially update information about a Theme resource.", + "summary": "Partially update information about a User resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateTheme", + "operationId": "updateUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the theme", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -71304,18 +71290,18 @@ } ], "requestBody": { - "description": "Partially update information about a Theme resource.", + "description": "Partially update information about a User resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -71327,7 +71313,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/User" } } } @@ -71342,7 +71328,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/User" } } } @@ -71361,14 +71347,14 @@ } } }, - "/aggregate/theme": { + "/aggregate/user": { "post": { "tags": [ - "Theme" + "User" ], - "summary": "Aggregate for the Theme resources.", + "summary": "Aggregate for the User resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTheme", + "operationId": "aggregateUser", "requestBody": { "required": true, "content": { @@ -71392,7 +71378,7 @@ }, "responses": { "200": { - "description": "List of Theme", + "description": "List of User", "content": { "application/vnd.api+json": { "schema": { @@ -71406,7 +71392,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/User" } } } @@ -71424,7 +71410,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/User" } } } @@ -71441,14 +71427,14 @@ } } }, - "/unit": { + "/user-access-key": { "get": { "tags": [ - "Unit" + "User Access Key" ], - "summary": "List with basic information of Unit resources.", + "summary": "List with basic information of User Access Key resources.", "description": "Available since: 6.0.0.0", - "operationId": "getUnitList", + "operationId": "getUserAccessKeyList", "parameters": [ { "name": "limit", @@ -71477,7 +71463,7 @@ ], "responses": { "200": { - "description": "List of Unit resources.", + "description": "List of User Access Key resources.", "content": { "application/vnd.api+json": { "schema": { @@ -71496,7 +71482,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/UserAccessKey" } } ] @@ -71510,16 +71496,16 @@ "type": "object", "properties": { "first": { - "example": "/unit?limit=25" + "example": "/user-access-key?limit=25" }, "last": { - "example": "/unit?limit=25&page=11" + "example": "/user-access-key?limit=25&page=11" }, "next": { - "example": "/unit?limit=25&page=4" + "example": "/user-access-key?limit=25&page=4" }, "prev": { - "example": "/unit?limit=25&page=2" + "example": "/user-access-key?limit=25&page=2" } } } @@ -71540,7 +71526,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -71555,11 +71541,11 @@ }, "post": { "tags": [ - "Unit" + "User Access Key" ], - "summary": "Create a new Unit resources.", + "summary": "Create a new User Access Key resources.", "description": "Available since: 6.0.0.0", - "operationId": "createUnit", + "operationId": "createUserAccessKey", "parameters": [ { "name": "_response", @@ -71578,14 +71564,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/UserAccessKey" } } } }, "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -71597,7 +71583,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -71612,7 +71598,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -71628,14 +71614,14 @@ } } }, - "/search/unit": { + "/search/user-access-key": { "post": { "tags": [ - "Unit" + "User Access Key" ], - "summary": "Search for the Unit resources.", + "summary": "Search for the User Access Key resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchUnit", + "operationId": "searchUserAccessKey", "parameters": [ { "name": "sw-include-search-info", @@ -71663,7 +71649,7 @@ }, "responses": { "200": { - "description": "List of Unit", + "description": "List of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -71677,7 +71663,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -71695,7 +71681,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -71712,19 +71698,19 @@ } } }, - "/unit/{id}": { + "/user-access-key/{id}": { "get": { "tags": [ - "Unit" + "User Access Key" ], - "summary": "Detailed information about a Unit resource.", + "summary": "Detailed information about a User Access Key resource.", "description": "Available since: 6.0.0.0", - "operationId": "getUnit", + "operationId": "getUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the unit", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -71734,7 +71720,7 @@ ], "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -71746,7 +71732,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -71761,7 +71747,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -71778,16 +71764,16 @@ }, "delete": { "tags": [ - "Unit" + "User Access Key" ], - "summary": "Delete a Unit resource.", + "summary": "Delete a User Access Key resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteUnit", + "operationId": "deleteUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the unit", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -71818,16 +71804,16 @@ }, "patch": { "tags": [ - "Unit" + "User Access Key" ], - "summary": "Partially update information about a Unit resource.", + "summary": "Partially update information about a User Access Key resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateUnit", + "operationId": "updateUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the unit", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -71845,18 +71831,18 @@ } ], "requestBody": { - "description": "Partially update information about a Unit resource.", + "description": "Partially update information about a User Access Key resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/UserAccessKey" } } } }, "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -71868,7 +71854,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -71883,7 +71869,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -71902,14 +71888,14 @@ } } }, - "/aggregate/unit": { + "/aggregate/user-access-key": { "post": { "tags": [ - "Unit" + "User Access Key" ], - "summary": "Aggregate for the Unit resources.", + "summary": "Aggregate for the User Access Key resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUnit", + "operationId": "aggregateUserAccessKey", "requestBody": { "required": true, "content": { @@ -71933,7 +71919,7 @@ }, "responses": { "200": { - "description": "List of Unit", + "description": "List of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -71947,7 +71933,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -71965,7 +71951,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -71982,14 +71968,14 @@ } } }, - "/user": { + "/user-config": { "get": { "tags": [ - "User" + "User Config" ], - "summary": "List with basic information of User resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserList", + "summary": "List with basic information of User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "getUserConfigList", "parameters": [ { "name": "limit", @@ -72018,7 +72004,7 @@ ], "responses": { "200": { - "description": "List of User resources.", + "description": "List of User Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -72037,7 +72023,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserConfig" } } ] @@ -72051,16 +72037,16 @@ "type": "object", "properties": { "first": { - "example": "/user?limit=25" + "example": "/user-config?limit=25" }, "last": { - "example": "/user?limit=25&page=11" + "example": "/user-config?limit=25&page=11" }, "next": { - "example": "/user?limit=25&page=4" + "example": "/user-config?limit=25&page=4" }, "prev": { - "example": "/user?limit=25&page=2" + "example": "/user-config?limit=25&page=2" } } } @@ -72081,7 +72067,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserConfig" } } } @@ -72096,11 +72082,11 @@ }, "post": { "tags": [ - "User" + "User Config" ], - "summary": "Create a new User resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createUser", + "summary": "Create a new User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "createUserConfig", "parameters": [ { "name": "_response", @@ -72119,14 +72105,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { - "description": "Detail of User", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -72138,7 +72124,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserConfig" } } } @@ -72153,7 +72139,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserConfig" } } } @@ -72169,14 +72155,14 @@ } } }, - "/search/user": { + "/search/user-config": { "post": { "tags": [ - "User" + "User Config" ], - "summary": "Search for the User resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchUser", + "summary": "Search for the User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "searchUserConfig", "parameters": [ { "name": "sw-include-search-info", @@ -72204,7 +72190,7 @@ }, "responses": { "200": { - "description": "List of User", + "description": "List of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -72218,7 +72204,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserConfig" } } } @@ -72236,7 +72222,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserConfig" } } } @@ -72253,19 +72239,19 @@ } } }, - "/user/{id}": { + "/user-config/{id}": { "get": { "tags": [ - "User" + "User Config" ], - "summary": "Detailed information about a User resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getUser", + "summary": "Detailed information about a User Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "getUserConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -72275,7 +72261,7 @@ ], "responses": { "200": { - "description": "Detail of User", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -72287,7 +72273,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserConfig" } } } @@ -72302,7 +72288,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserConfig" } } } @@ -72319,16 +72305,16 @@ }, "delete": { "tags": [ - "User" + "User Config" ], - "summary": "Delete a User resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteUser", + "summary": "Delete a User Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "deleteUserConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -72359,16 +72345,16 @@ }, "patch": { "tags": [ - "User" + "User Config" ], - "summary": "Partially update information about a User resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateUser", + "summary": "Partially update information about a User Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "updateUserConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -72386,18 +72372,18 @@ } ], "requestBody": { - "description": "Partially update information about a User resource.", + "description": "Partially update information about a User Config resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { - "description": "Detail of User", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -72409,7 +72395,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserConfig" } } } @@ -72424,7 +72410,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserConfig" } } } @@ -72443,14 +72429,14 @@ } } }, - "/aggregate/user": { + "/aggregate/user-config": { "post": { "tags": [ - "User" + "User Config" ], - "summary": "Aggregate for the User resources.", + "summary": "Aggregate for the User Config resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUser", + "operationId": "aggregateUserConfig", "requestBody": { "required": true, "content": { @@ -72474,7 +72460,7 @@ }, "responses": { "200": { - "description": "List of User", + "description": "List of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -72488,7 +72474,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserConfig" } } } @@ -72506,7 +72492,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserConfig" } } } @@ -72523,14 +72509,14 @@ } } }, - "/user-access-key": { + "/user-recovery": { "get": { "tags": [ - "User Access Key" + "User Recovery" ], - "summary": "List with basic information of User Access Key resources.", + "summary": "List with basic information of User Recovery resources.", "description": "Available since: 6.0.0.0", - "operationId": "getUserAccessKeyList", + "operationId": "getUserRecoveryList", "parameters": [ { "name": "limit", @@ -72559,7 +72545,7 @@ ], "responses": { "200": { - "description": "List of User Access Key resources.", + "description": "List of User Recovery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -72578,7 +72564,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserRecovery" } } ] @@ -72592,16 +72578,16 @@ "type": "object", "properties": { "first": { - "example": "/user-access-key?limit=25" + "example": "/user-recovery?limit=25" }, "last": { - "example": "/user-access-key?limit=25&page=11" + "example": "/user-recovery?limit=25&page=11" }, "next": { - "example": "/user-access-key?limit=25&page=4" + "example": "/user-recovery?limit=25&page=4" }, "prev": { - "example": "/user-access-key?limit=25&page=2" + "example": "/user-recovery?limit=25&page=2" } } } @@ -72622,7 +72608,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -72637,11 +72623,11 @@ }, "post": { "tags": [ - "User Access Key" + "User Recovery" ], - "summary": "Create a new User Access Key resources.", + "summary": "Create a new User Recovery resources.", "description": "Available since: 6.0.0.0", - "operationId": "createUserAccessKey", + "operationId": "createUserRecovery", "parameters": [ { "name": "_response", @@ -72660,14 +72646,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserRecovery" } } } }, "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -72679,7 +72665,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -72694,7 +72680,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -72710,14 +72696,14 @@ } } }, - "/search/user-access-key": { + "/search/user-recovery": { "post": { "tags": [ - "User Access Key" + "User Recovery" ], - "summary": "Search for the User Access Key resources.", + "summary": "Search for the User Recovery resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchUserAccessKey", + "operationId": "searchUserRecovery", "parameters": [ { "name": "sw-include-search-info", @@ -72745,7 +72731,7 @@ }, "responses": { "200": { - "description": "List of UserAccessKey", + "description": "List of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -72759,7 +72745,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -72777,7 +72763,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -72794,19 +72780,19 @@ } } }, - "/user-access-key/{id}": { + "/user-recovery/{id}": { "get": { "tags": [ - "User Access Key" + "User Recovery" ], - "summary": "Detailed information about a User Access Key resource.", + "summary": "Detailed information about a User Recovery resource.", "description": "Available since: 6.0.0.0", - "operationId": "getUserAccessKey", + "operationId": "getUserRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_access_key", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -72816,7 +72802,7 @@ ], "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -72828,7 +72814,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -72843,7 +72829,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -72860,16 +72846,16 @@ }, "delete": { "tags": [ - "User Access Key" + "User Recovery" ], - "summary": "Delete a User Access Key resource.", + "summary": "Delete a User Recovery resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteUserAccessKey", + "operationId": "deleteUserRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_access_key", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -72900,16 +72886,16 @@ }, "patch": { "tags": [ - "User Access Key" + "User Recovery" ], - "summary": "Partially update information about a User Access Key resource.", + "summary": "Partially update information about a User Recovery resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateUserAccessKey", + "operationId": "updateUserRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_access_key", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -72927,18 +72913,18 @@ } ], "requestBody": { - "description": "Partially update information about a User Access Key resource.", + "description": "Partially update information about a User Recovery resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserRecovery" } } } }, "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -72950,7 +72936,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -72965,7 +72951,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -72984,14 +72970,14 @@ } } }, - "/aggregate/user-access-key": { + "/aggregate/user-recovery": { "post": { "tags": [ - "User Access Key" + "User Recovery" ], - "summary": "Aggregate for the User Access Key resources.", + "summary": "Aggregate for the User Recovery resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUserAccessKey", + "operationId": "aggregateUserRecovery", "requestBody": { "required": true, "content": { @@ -73015,7 +73001,7 @@ }, "responses": { "200": { - "description": "List of UserAccessKey", + "description": "List of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -73029,7 +73015,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -73047,7 +73033,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -73064,14 +73050,14 @@ } } }, - "/user-config": { + "/webhook": { "get": { "tags": [ - "User Config" + "Webhook" ], - "summary": "List with basic information of User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "getUserConfigList", + "summary": "List with basic information of Webhook resources.", + "description": "Available since: 6.3.1.0", + "operationId": "getWebhookList", "parameters": [ { "name": "limit", @@ -73100,7 +73086,7 @@ ], "responses": { "200": { - "description": "List of User Config resources.", + "description": "List of Webhook resources.", "content": { "application/vnd.api+json": { "schema": { @@ -73119,7 +73105,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/Webhook" } } ] @@ -73133,16 +73119,16 @@ "type": "object", "properties": { "first": { - "example": "/user-config?limit=25" + "example": "/webhook?limit=25" }, "last": { - "example": "/user-config?limit=25&page=11" + "example": "/webhook?limit=25&page=11" }, "next": { - "example": "/user-config?limit=25&page=4" + "example": "/webhook?limit=25&page=4" }, "prev": { - "example": "/user-config?limit=25&page=2" + "example": "/webhook?limit=25&page=2" } } } @@ -73163,7 +73149,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/Webhook" } } } @@ -73178,11 +73164,11 @@ }, "post": { "tags": [ - "User Config" + "Webhook" ], - "summary": "Create a new User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "createUserConfig", + "summary": "Create a new Webhook resources.", + "description": "Available since: 6.3.1.0", + "operationId": "createWebhook", "parameters": [ { "name": "_response", @@ -73201,14 +73187,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -73220,7 +73206,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/Webhook" } } } @@ -73235,7 +73221,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/Webhook" } } } @@ -73251,14 +73237,14 @@ } } }, - "/search/user-config": { + "/search/webhook": { "post": { "tags": [ - "User Config" + "Webhook" ], - "summary": "Search for the User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "searchUserConfig", + "summary": "Search for the Webhook resources.", + "description": "Available since: 6.3.1.0", + "operationId": "searchWebhook", "parameters": [ { "name": "sw-include-search-info", @@ -73286,7 +73272,7 @@ }, "responses": { "200": { - "description": "List of UserConfig", + "description": "List of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -73300,7 +73286,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/Webhook" } } } @@ -73318,7 +73304,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/Webhook" } } } @@ -73335,19 +73321,19 @@ } } }, - "/user-config/{id}": { + "/webhook/{id}": { "get": { "tags": [ - "User Config" + "Webhook" ], - "summary": "Detailed information about a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "getUserConfig", + "summary": "Detailed information about a Webhook resource.", + "description": "Available since: 6.3.1.0", + "operationId": "getWebhook", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_config", + "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", @@ -73357,7 +73343,7 @@ ], "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -73369,7 +73355,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/Webhook" } } } @@ -73384,7 +73370,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/Webhook" } } } @@ -73401,16 +73387,16 @@ }, "delete": { "tags": [ - "User Config" + "Webhook" ], - "summary": "Delete a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "deleteUserConfig", + "summary": "Delete a Webhook resource.", + "description": "Available since: 6.3.1.0", + "operationId": "deleteWebhook", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_config", + "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", @@ -73441,16 +73427,16 @@ }, "patch": { "tags": [ - "User Config" + "Webhook" ], - "summary": "Partially update information about a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "updateUserConfig", + "summary": "Partially update information about a Webhook resource.", + "description": "Available since: 6.3.1.0", + "operationId": "updateWebhook", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_config", + "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", @@ -73468,18 +73454,18 @@ } ], "requestBody": { - "description": "Partially update information about a User Config resource.", + "description": "Partially update information about a Webhook resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -73491,7 +73477,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/Webhook" } } } @@ -73506,7 +73492,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/Webhook" } } } @@ -73525,14 +73511,14 @@ } } }, - "/aggregate/user-config": { + "/aggregate/webhook": { "post": { "tags": [ - "User Config" + "Webhook" ], - "summary": "Aggregate for the User Config resources.", + "summary": "Aggregate for the Webhook resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUserConfig", + "operationId": "aggregateWebhook", "requestBody": { "required": true, "content": { @@ -73556,7 +73542,7 @@ }, "responses": { "200": { - "description": "List of UserConfig", + "description": "List of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -73570,7 +73556,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/Webhook" } } } @@ -73588,7 +73574,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/Webhook" } } } @@ -73605,14 +73591,14 @@ } } }, - "/user-recovery": { + "/webhook-event-log": { "get": { "tags": [ - "User Recovery" + "Webhook Event Log" ], - "summary": "List with basic information of User Recovery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserRecoveryList", + "summary": "List with basic information of Webhook Event Log resources.", + "description": "Available since: 6.4.1.0", + "operationId": "getWebhookEventLogList", "parameters": [ { "name": "limit", @@ -73641,7 +73627,7 @@ ], "responses": { "200": { - "description": "List of User Recovery resources.", + "description": "List of Webhook Event Log resources.", "content": { "application/vnd.api+json": { "schema": { @@ -73660,7 +73646,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/WebhookEventLog" } } ] @@ -73674,16 +73660,16 @@ "type": "object", "properties": { "first": { - "example": "/user-recovery?limit=25" + "example": "/webhook-event-log?limit=25" }, "last": { - "example": "/user-recovery?limit=25&page=11" + "example": "/webhook-event-log?limit=25&page=11" }, "next": { - "example": "/user-recovery?limit=25&page=4" + "example": "/webhook-event-log?limit=25&page=4" }, "prev": { - "example": "/user-recovery?limit=25&page=2" + "example": "/webhook-event-log?limit=25&page=2" } } } @@ -73704,7 +73690,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/WebhookEventLog" } } } @@ -73719,11 +73705,11 @@ }, "post": { "tags": [ - "User Recovery" + "Webhook Event Log" ], - "summary": "Create a new User Recovery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createUserRecovery", + "summary": "Create a new Webhook Event Log resources.", + "description": "Available since: 6.4.1.0", + "operationId": "createWebhookEventLog", "parameters": [ { "name": "_response", @@ -73742,14 +73728,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/WebhookEventLog" } } } }, "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of WebhookEventLog", "content": { "application/vnd.api+json": { "schema": { @@ -73761,7 +73747,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/WebhookEventLog" } } } @@ -73776,7 +73762,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/WebhookEventLog" } } } @@ -73792,14 +73778,14 @@ } } }, - "/search/user-recovery": { + "/search/webhook-event-log": { "post": { "tags": [ - "User Recovery" + "Webhook Event Log" ], - "summary": "Search for the User Recovery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchUserRecovery", + "summary": "Search for the Webhook Event Log resources.", + "description": "Available since: 6.4.1.0", + "operationId": "searchWebhookEventLog", "parameters": [ { "name": "sw-include-search-info", @@ -73827,7 +73813,7 @@ }, "responses": { "200": { - "description": "List of UserRecovery", + "description": "List of WebhookEventLog", "content": { "application/vnd.api+json": { "schema": { @@ -73841,7 +73827,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/WebhookEventLog" } } } @@ -73859,7 +73845,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/WebhookEventLog" } } } @@ -73876,19 +73862,19 @@ } } }, - "/user-recovery/{id}": { + "/webhook-event-log/{id}": { "get": { "tags": [ - "User Recovery" + "Webhook Event Log" ], - "summary": "Detailed information about a User Recovery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserRecovery", + "summary": "Detailed information about a Webhook Event Log resource.", + "description": "Available since: 6.4.1.0", + "operationId": "getWebhookEventLog", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_recovery", + "description": "Identifier for the webhook_event_log", "required": true, "schema": { "type": "string", @@ -73898,7 +73884,7 @@ ], "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of WebhookEventLog", "content": { "application/vnd.api+json": { "schema": { @@ -73910,7 +73896,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/WebhookEventLog" } } } @@ -73925,7 +73911,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/WebhookEventLog" } } } @@ -73942,1098 +73928,16 @@ }, "delete": { "tags": [ - "User Recovery" + "Webhook Event Log" ], - "summary": "Delete a User Recovery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteUserRecovery", + "summary": "Delete a Webhook Event Log resource.", + "description": "Available since: 6.4.1.0", + "operationId": "deleteWebhookEventLog", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_recovery", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "User Recovery" - ], - "summary": "Partially update information about a User Recovery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateUserRecovery", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the user_recovery", - "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 User Recovery resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserRecovery" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of UserRecovery", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserRecovery" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/UserRecovery" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/user-recovery": { - "post": { - "tags": [ - "User Recovery" - ], - "summary": "Aggregate for the User Recovery resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateUserRecovery", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of UserRecovery", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserRecovery" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserRecovery" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/webhook": { - "get": { - "tags": [ - "Webhook" - ], - "summary": "List with basic information of Webhook resources.", - "description": "Available since: 6.3.1.0", - "operationId": "getWebhookList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Webhook 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/Webhook" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/webhook?limit=25" - }, - "last": { - "example": "/webhook?limit=25&page=11" - }, - "next": { - "example": "/webhook?limit=25&page=4" - }, - "prev": { - "example": "/webhook?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Webhook" - ], - "summary": "Create a new Webhook resources.", - "description": "Available since: 6.3.1.0", - "operationId": "createWebhook", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Webhook" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Webhook", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Webhook" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/Webhook" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/webhook": { - "post": { - "tags": [ - "Webhook" - ], - "summary": "Search for the Webhook resources.", - "description": "Available since: 6.3.1.0", - "operationId": "searchWebhook", - "parameters": [ - { - "name": "sw-include-search-info", - "in": "header", - "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", - "schema": { - "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Webhook", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/webhook/{id}": { - "get": { - "tags": [ - "Webhook" - ], - "summary": "Detailed information about a Webhook resource.", - "description": "Available since: 6.3.1.0", - "operationId": "getWebhook", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the webhook", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Webhook", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Webhook" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/Webhook" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Webhook" - ], - "summary": "Delete a Webhook resource.", - "description": "Available since: 6.3.1.0", - "operationId": "deleteWebhook", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the webhook", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Webhook" - ], - "summary": "Partially update information about a Webhook resource.", - "description": "Available since: 6.3.1.0", - "operationId": "updateWebhook", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the webhook", - "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 Webhook resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Webhook" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Webhook", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Webhook" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/Webhook" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/webhook": { - "post": { - "tags": [ - "Webhook" - ], - "summary": "Aggregate for the Webhook resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateWebhook", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Webhook", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/webhook-event-log": { - "get": { - "tags": [ - "Webhook Event Log" - ], - "summary": "List with basic information of Webhook Event Log resources.", - "description": "Available since: 6.4.1.0", - "operationId": "getWebhookEventLogList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Webhook Event Log 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/WebhookEventLog" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/webhook-event-log?limit=25" - }, - "last": { - "example": "/webhook-event-log?limit=25&page=11" - }, - "next": { - "example": "/webhook-event-log?limit=25&page=4" - }, - "prev": { - "example": "/webhook-event-log?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookEventLog" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Webhook Event Log" - ], - "summary": "Create a new Webhook Event Log resources.", - "description": "Available since: 6.4.1.0", - "operationId": "createWebhookEventLog", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebhookEventLog" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of WebhookEventLog", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WebhookEventLog" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/WebhookEventLog" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/webhook-event-log": { - "post": { - "tags": [ - "Webhook Event Log" - ], - "summary": "Search for the Webhook Event Log resources.", - "description": "Available since: 6.4.1.0", - "operationId": "searchWebhookEventLog", - "parameters": [ - { - "name": "sw-include-search-info", - "in": "header", - "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", - "schema": { - "type": "string", - "enum": [ - "0", - "1" - ], - "default": "1" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of WebhookEventLog", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookEventLog" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookEventLog" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/webhook-event-log/{id}": { - "get": { - "tags": [ - "Webhook Event Log" - ], - "summary": "Detailed information about a Webhook Event Log resource.", - "description": "Available since: 6.4.1.0", - "operationId": "getWebhookEventLog", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the webhook_event_log", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of WebhookEventLog", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WebhookEventLog" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/WebhookEventLog" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Webhook Event Log" - ], - "summary": "Delete a Webhook Event Log resource.", - "description": "Available since: 6.4.1.0", - "operationId": "deleteWebhookEventLog", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the webhook_event_log", + "description": "Identifier for the webhook_event_log", "required": true, "schema": { "type": "string", @@ -78799,21 +77703,15 @@ "identifier": "userId-12345", "status": "accepted", "actor": "userId-12345", - "updatedAt": "2024-01-15T10:20:30Z", - "acceptedUntil": "2024-01-15T10:20:30Z", - "acceptedRevision": "2026-02-01", - "latestRevision": "2026-02-01" + "updatedAt": "2024-01-15T10:20:30Z" }, "backend_data": { "name": "backend_data", "scopeName": "system", "identifier": "system", - "status": "unset", + "status": "requested", "actor": null, - "updatedAt": null, - "acceptedUntil": null, - "acceptedRevision": null, - "latestRevision": null + "updatedAt": null } } } @@ -78844,21 +77742,13 @@ "consent": { "type": "string", "description": "The name of the consent to accept" - }, - "revision": { - "type": [ - "string", - "null" - ], - "description": "Optional accepted revision. Only the consent definition's latest revision is accepted. When omitted, the latest revision is used automatically." } }, "required": [ "consent" ], "example": { - "consent": "product_analytics", - "revision": "2026-02-01" + "consent": "product_analytics" } } } @@ -78875,9 +77765,6 @@ } } }, - "400": { - "description": "Bad request - Consent revision is invalid for current acceptance" - }, "404": { "description": "Bad request - Consent not found or consent property was empty" }, @@ -87041,40 +85928,6 @@ "format": "date-time", "readOnly": true }, - "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" - } - }, - "type": "object" - }, "relationships": { "properties": { "group": { @@ -87885,40 +86738,6 @@ "format": "date-time", "readOnly": true }, - "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" - } - }, - "type": "object" - }, "group": { "$ref": "#/components/schemas/CustomerGroup", "description": "Customer group determining pricing and permissions" @@ -93327,9 +92146,6 @@ "systemDefault": { "type": "boolean" }, - "wasModifiedByUser": { - "type": "boolean" - }, "senderName": { "type": "string" }, @@ -93455,9 +92271,6 @@ "type": "boolean", "description": "Unused field. To be removed in future." }, - "wasModifiedByUser": { - "type": "boolean" - }, "senderName": { "type": "string", "description": "Name of the sender in the mail." @@ -94848,37 +93661,6 @@ }, "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": { @@ -95396,12 +94178,6 @@ "$ref": "#/components/schemas/ProductConfiguratorSetting" } }, - "productOpenGraphImages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - }, "orderLineItems": { "type": "array", "items": { @@ -98041,40 +96817,6 @@ "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": { @@ -98915,40 +97657,6 @@ "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)" @@ -103937,11 +102645,6 @@ "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": { @@ -103975,6 +102678,12 @@ "description": "When the value is set to true, the product is hidden when sold out.", "type": "boolean" }, + "availableStock": { + "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", + "type": "integer", + "format": "int64", + "readOnly": true + }, "stock": { "description": "Indicates the number of products available.", "type": "integer", @@ -104172,12 +102881,6 @@ "additionalProperties": false } }, - "ogTitle": { - "type": "string" - }, - "ogDescription": { - "type": "string" - }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -104194,13 +102897,6 @@ "readOnly": true, "deprecated": true }, - "availableStock": { - "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", - "type": "integer", - "format": "int64", - "readOnly": true, - "deprecated": true - }, "createdAt": { "type": "string", "format": "date-time", @@ -104460,36 +103156,6 @@ }, "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": { @@ -105278,11 +103944,6 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS page's version." }, - "openGraphMediaId": { - "description": "Media used as Open Graph image for social media sharing.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "price": { "type": "array", "items": { @@ -105318,6 +103979,12 @@ "description": "When the value is set to true, the product is hidden when sold out.", "type": "boolean" }, + "availableStock": { + "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", + "type": "integer", + "format": "int64", + "readOnly": true + }, "stock": { "description": "Indicates the number of products available.", "type": "integer", @@ -105536,12 +104203,6 @@ }, "description": "List of additional keywords in the search." }, - "ogTitle": { - "type": "string" - }, - "ogDescription": { - "type": "string" - }, "type": { "description": "The type of the product, e.g., physical or digital.", "type": "string", @@ -105559,13 +104220,6 @@ "deprecated": true, "description": "Internal field." }, - "availableStock": { - "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", - "type": "integer", - "format": "int64", - "readOnly": true, - "deprecated": true - }, "createdAt": { "type": "string", "format": "date-time", @@ -105618,10 +104272,6 @@ "$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" }, @@ -106785,10 +105435,6 @@ "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" @@ -107055,10 +105701,6 @@ "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" @@ -107834,6 +106476,9 @@ "$ref": "#/components/schemas/Price" } }, + "customFields": { + "type": "object" + }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "integer", @@ -107844,9 +106489,6 @@ "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -107967,6 +106609,10 @@ }, "description": "Price of the Product." }, + "customFields": { + "type": "object", + "description": "Additional fields that offer a possibility to add own fields for the different program-areas." + }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "integer", @@ -107977,10 +106623,6 @@ "type": "integer", "format": "int64" }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, "createdAt": { "type": "string", "format": "date-time", @@ -109654,12 +108296,7 @@ "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", - "enum": [ - 10, - 20, - 30 - ] + "format": "int64" }, "createdAt": { "type": "string", @@ -109771,12 +108408,7 @@ "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", - "enum": [ - 10, - 20, - 30 - ] + "format": "int64" }, "createdAt": { "type": "string", @@ -113038,68 +111670,6 @@ }, "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": { @@ -114485,68 +113055,6 @@ }, "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": { @@ -115402,298 +113910,6 @@ }, "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": [ @@ -115893,11 +114109,6 @@ "customFields": { "type": "object" }, - "position": { - "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", - "type": "integer", - "format": "int64" - }, "createdAt": { "type": "string", "format": "date-time", @@ -116106,11 +114317,6 @@ "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "position": { - "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", - "type": "integer", - "format": "int64" - }, "createdAt": { "type": "string", "format": "date-time", @@ -122461,20 +120667,6 @@ ], "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." } } }, @@ -126040,14 +124232,6 @@ "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/adminapi.summary.json b/adminapi.summary.json index c35e1e1..bbc9b45 100644 --- a/adminapi.summary.json +++ b/adminapi.summary.json @@ -174,8 +174,6 @@ "/aggregate/sales-channel", "/aggregate/sales-channel-analytics", "/aggregate/sales-channel-domain", - "/aggregate/sales-channel-tracking-customer", - "/aggregate/sales-channel-tracking-order", "/aggregate/sales-channel-type", "/aggregate/salutation", "/aggregate/scheduled-task", @@ -430,10 +428,6 @@ "/sales-channel-analytics/{id}", "/sales-channel-domain", "/sales-channel-domain/{id}", - "/sales-channel-tracking-customer", - "/sales-channel-tracking-customer/{id}", - "/sales-channel-tracking-order", - "/sales-channel-tracking-order/{id}", "/sales-channel-type", "/sales-channel-type/{id}", "/sales-channel/{id}", @@ -552,8 +546,6 @@ "/search/sales-channel", "/search/sales-channel-analytics", "/search/sales-channel-domain", - "/search/sales-channel-tracking-customer", - "/search/sales-channel-tracking-order", "/search/sales-channel-type", "/search/salutation", "/search/scheduled-task", @@ -930,10 +922,6 @@ "SalesChannelLanguage", "SalesChannelPaymentMethod", "SalesChannelShippingMethod", - "SalesChannelTrackingCustomer", - "SalesChannelTrackingCustomerJsonApi", - "SalesChannelTrackingOrder", - "SalesChannelTrackingOrderJsonApi", "SalesChannelType", "SalesChannelTypeJsonApi", "Salutation",